Gyors kezdés

Töltse fel első fájlját az IPFS-re kevesebb mint két perc alatt.

1. Szerezze be API kulcsát

Regisztráljon az ipfs.ninja oldalon Google-fiókjával. Az alapértelmezett API kulcs automatikusan létrejön. Lépjen a Profil oldalra az API kulcsai megtekintéséhez és kezeléséhez.

WARNING

Megjegyzés: Az API kulcsok nem járnak le. Több kulcsot is létrehozhat, és egyenként visszavonhatja őket a Profil oldalról.

2. Töltsön fel egy fájlt

Küldjön egy POST kérést a /upload/new végpontra a tartalmával. Íme egy példa egy JSON objektum feltöltésére:

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..."

Az API visszaadja a CID-et, a fájlméretet és a hozzáférési URI-kat:

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

3. Kérje le a fájlját

Kétféleképpen érheti el fájlját:

Az IPFS gateway-en keresztül (nyilvános, hitelesítés nélkül)

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

Az API-n keresztül (fájl metaadatokat ad vissza)

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

Válasz:

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

Következő lépések

• API referencia — Teljes dokumentáció az összes végpontról, paraméterről és hibakódról.
• Dedikált gateway-ek — Szerezzen privát gateway-t, amely csak az Ön fájljait szolgálja ki. Elérhető a Nirvana csomagban.