Kiirstart

Laadige oma esimene fail IPFS-i üles vähem kui kahe minutiga.

1. Hankige oma API-võti

Registreeruge aadressil ipfs.ninja oma Google'i kontoga. Vaike-API-võti luuakse automaatselt. Minge oma Profiililehele, et vaadata ja hallata oma API-võtmeid.

WARNING

Märkus: API-võtmed ei aegu. Saate luua mitu võtit ja tühistada need ükshaaval oma Profiililehelt.

2. Laadige fail üles

Saatke POST-päring aadressile /upload/new koos oma sisuga. Siin on näide JSON-objekti üleslaadimisest:

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 vaikimisi

Uued üleslaadimised toodavad kaasaegse CIDv1 (bafk… väikese üheplokilise sisu jaoks, bafy… suuremate failide ja kataloogide jaoks) vastavalt IPIP-0499. Varasemate üleslaadimiste vanapärased Qm… CID-d lahenduvad ikka kõikjal — mõlemad formaadid töötavad sisendina igal lõpp-punktil.

API tagastab CID, failisuuruse ja juurdepääsu-URI-d:

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

3. Hankige oma fail

Pääsege oma failile ligi kahel viisil:

IPFS-gateway kaudu (avalik, autentimine pole vajalik)

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

TIP

Apex-värav https://ipfs.ninja/ipfs/<CID> teenindab CID-sid, mille on üles laadinud või kinnitanud iga IPFS Ninja kasutaja. Platvormile tundmatud CID-d tagastavad HTTP 410 Gone — nende jaoks kasuta avalikku väravat (ipfs.io, dweb.link) või tee esmalt POST /pin CID-le oma kontole.

API kaudu (tagastab faili metaandmed)

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

Vastus:

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

Alternatiiv: kasuta AWS SDK-d (S3-ühilduv)

Kas kasutad juba S3-d? Suuna oma olemasolev AWS SDK aadressile https://s3.ipfs.ninja ja kasuta oma API-võtit volitustena:

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" })
}));

Vaadake S3 ühilduvus täielikku dokumentatsiooni Python, Go ja migratsiooninäidetega.

Eelistad klõpsamist? Kasuta töölauda

Kui sa ei taha koodi kirjutada, aktsepteerib ipfs.ninja/upload lohistamist:

• Mis tahes fail — lohista see üleslaadimistsooni, see kinnitatakse + saad CID-i
• Kaust — pakitakse UnixFS-kataloogiks sinu brauseris, laaditakse üles ühe impordina, lahendub aadressil /ipfs/{cid}/{subpath} iga lapsfaili jaoks
• .car-arhiiv — tuvastatakse automaatselt, root CID säilitatakse täpselt (vt CAR Import)

Pärast üleslaadimist ilmuvad failid Failide lehele, kus saad neid ümber nimetada, kaustade vahel liigutada, hankida terve kausta jaoks IPFS-kataloogi CID-i (hetktõmmis), ja konfigureerida kausta-põhist S3 CORS-i brauseri SDK ligipääsuks.

Järgmised sammud

• API viide — Täielik dokumentatsioon kõigi lõpp-punktide, parameetrite ja veakoodide kohta.
• S3 ühilduvus — Kasuta AWS SDK-d IPFS Ninja-ga suhtlemiseks.
• Pühendatud gatewayd — Hankige privaatne gateway, mis teenindab ainult teie faile.