Pikaopas

Lataa ensimmäinen tiedostosi IPFS:ään alle kahdessa minuutissa.

1. Hanki API-avaimesi

Rekisteröidy osoitteessa ipfs.ninja Google-tililläsi. Oletus API-avain luodaan automaattisesti. Siirry Profiilisivulle tarkastellaksesi ja hallitaksesi API-avaimiasi.

WARNING

Huomio: API-avaimet eivät vanhene. Voit luoda useita avaimia ja peruuttaa ne yksitellen Profiilisivultasi.

2. Lataa tiedosto

Lähetä POST-pyyntö osoitteeseen /upload/new sisältösi kanssa. Tässä on esimerkki JSON-objektin lataamisesta:

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

API palauttaa CID:n, tiedostokoon ja pääsy-URI:t:

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

3. Hae tiedostosi

Pääse tiedostoosi kahdella tavalla:

IPFS-gatewayn kautta (julkinen, ei todennusta tarvita)

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

API:n kautta (palauttaa tiedoston metatiedot)

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

Vastaus:

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

Seuraavat vaiheet

• API-viite — Täydellinen dokumentaatio kaikista päätepisteistä, parametreista ja virhekodeista.
• Dedikoidut gatewayt — Hanki yksityinen gateway, joka palvelee vain sinun tiedostojasi. Saatavilla Nirvana-suunnitelmassa.