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://bafybeiExampleCID..."
    },
    "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://bafybeiExampleCID..."
    },
    description: "NFT metadata"
  })
});

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

CIDv1 oletuksena

Uudet lataukset tuottavat nykyaikaisen CIDv1-tunnisteen (bafk… pienelle yksilohkoiselle sisällölle, bafy… suuremmille tiedostoille ja hakemistoille) IPIP-0499 mukaisesti. Aiempien latausten vanhat Qm…-CID:t ratkeavat edelleen kaikkialla — molemmat muodot toimivat syötteinä jokaiselle päätepisteelle.

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

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

3. Hae tiedostosi

Pääse tiedostoosi kahdella tavalla:

IPFS-gatewayn kautta (ei todennusta tarvita)

curl https://ipfs.ninja/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi

TIP

Apex-gateway https://ipfs.ninja/ipfs/<CID> palvelee minkä tahansa IPFS Ninja -käyttäjän lataamia tai kiinnittämiä CID-tunnisteita. Alustalle tuntemattomille CID-tunnisteille palautetaan HTTP 410 Gone — niitä varten käytä julkista gatewayta (ipfs.io, dweb.link) tai suorita ensin POST /pin CID-tunnisteelle tilillesi.

API:n kautta (palauttaa tiedoston metatiedot)

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

Vastaus:

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

Vaihtoehto: käytä AWS SDK:ta (S3-yhteensopiva)

Käytätkö jo S3:a? Osoita olemassa oleva AWS SDK:si osoitteeseen https://s3.ipfs.ninja ja käytä API-avaintasi tunnistetietoina:

import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";

const s3 = new S3Client({
  endpoint: "https://s3.ipfs.ninja",
  credentials: { accessKeyId: "bws_prefix", secretAccessKey: "bws_fullkey" },
  region: "us-east-1",
  forcePathStyle: true
});

await s3.send(new PutObjectCommand({
  Bucket: "my-project",
  Key: "my-file.json",
  Body: JSON.stringify({ hello: "IPFS" })
}));

Katso S3-yhteensopivuus täydellinen dokumentaatio Python-, Go- ja migraatioesimerkkien kanssa.

Haluatko mieluummin klikkailla? Käytä hallintapaneelia

Jos et halua kirjoittaa koodia, ipfs.ninja/upload hyväksyy vedä ja pudota -toiminnon seuraaville:

• Mikä tahansa tiedosto — pudota se latausalueelle, se kiinnitetään ja saat CID:n
• Kansio — pakataan UnixFS-hakemistoksi selaimessasi, ladataan yhtenä tuontina, ratkeaa osoitteessa /ipfs/{cid}/{subpath} jokaiselle lapsitiedostolle
• .car-arkisto — tunnistetaan automaattisesti, juuri-CID säilytetään täsmälleen (katso CAR-tuonti)

Latauksen jälkeen tiedostot näkyvät Tiedostot-sivulla, jossa voit nimetä uudelleen, siirtää kansioiden välillä, hakea IPFS-hakemisto-CID:n koko kansiolle (tilannevedos), ja määrittää bucket-kohtaisen S3 CORSin selain-SDK-käyttöä varten.

Seuraavat vaiheet

• API-viite — Täydellinen dokumentaatio kaikista päätepisteistä, parametreista ja virhekoodeista.
• S3-yhteensopivuus — Käytä AWS SDK:ta IPFS Ninjan kanssa toimimiseen.
• Dedikoidut gatewayt — Hanki yksityinen gateway, joka palvelee vain sinun tiedostojasi.