Snelstart

Upload je eerste bestand naar IPFS in minder dan twee minuten.

1. Haal je API-sleutel op

Registreer je op ipfs.ninja met je Google-account. Er wordt automatisch een standaard API-sleutel aangemaakt. Ga naar je Profielpagina om je API-sleutels te bekijken en beheren.

WARNING

Let op: API-sleutels verlopen niet. Je kunt meerdere sleutels aanmaken en ze afzonderlijk intrekken vanuit de Profielpagina.

2. Upload een bestand

Stuur een POST-verzoek naar /upload/new met je inhoud. Hier is een voorbeeld van het uploaden van een JSON-object:

curl

curl -X POST https://api.ipfs.ninja/upload/new \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {
      "name": "My NFT",
      "description": "A permanent file on IPFS",
      "image": "ipfs://QmExampleCID..."
    },
    "description": "NFT metadata"
  }'

JavaScript

const response = await fetch("https://api.ipfs.ninja/upload/new", {
  method: "POST",
  headers: {
    "X-Api-Key": "bws_your_api_key_here",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    content: {
      name: "My NFT",
      description: "A permanent file on IPFS",
      image: "ipfs://QmExampleCID..."
    },
    description: "NFT metadata"
  })
});

const data = await response.json();
console.log(data.cid);       // "QmXmCX9S6ANV..."
console.log(data.uris.url);  // "https://ipfs.ninja/ipfs/QmXmCX9S6ANV..."

De API retourneert de CID, bestandsgrootte en toegangs-URI's:

{
  "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
  "sizeMB": 0.001,
  "uris": {
    "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
  }
}

3. Haal je bestand op

Krijg toegang tot je bestand op twee manieren:

Via de IPFS-gateway (openbaar, geen authenticatie nodig)

curl https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN

Via de API (retourneert bestandsmetadata)

curl https://api.ipfs.ninja/file/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN \
  -H "X-Api-Key: bws_your_api_key_here"

Antwoord:

{
  "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
  "fileName": "NFT metadata",
  "fileType": "json",
  "sizeMB": 0.001,
  "createdAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
  }
}

Volgende stappen

• API-referentie -- Volledige documentatie voor alle endpoints, parameters en foutcodes.
• Dedicated gateways -- Krijg een prive-gateway die alleen je bestanden serveert. Beschikbaar met het Nirvana-plan.