Ātrais sākums

Augšupielādējiet savu pirmo failu IPFS mazāk nekā divās minūtēs.

1. Iegūstiet savu API atslēgu

Reģistrējieties vietnē ipfs.ninja ar savu Google kontu. Noklusējuma API atslēga tiek izveidota automātiski. Dodieties uz savu Profila lapu, lai skatītu un pārvaldītu savas API atslēgas.

WARNING

Piezīme: API atslēgas nebeidzas. Varat izveidot vairākas atslēgas un atsaukt tās atsevišķi no savas Profila lapas.

2. Augšupielādējiet failu

Nosūtiet POST pieprasījumu uz /upload/new ar savu saturu. Šeit ir piemērs JSON objekta augšupielādei:

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 pēc noklusējuma

Jaunas augšupielādes rada modernus CIDv1 (bafk… maza, viena bloka satura, bafy… lielākiem failiem un direktorijām) saskaņā ar IPIP-0499. Iepriekšējo augšupielāžu vecmodīgie Qm… CID joprojām atrisinās visur — abi formāti darbojas kā ievade jebkuram galapunktam.

API atgriež CID, faila izmēru un piekļuves URI:

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

3. Izgūstiet savu failu

Piekļūstiet savam failam divos veidos:

Caur IPFS gateway (autentifikācija nav nepieciešama)

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

TIP

Apex gateway https://ipfs.ninja/ipfs/<CID> apkalpo CID, kurus ir augšupielādējis vai piesprauda jebkurš IPFS Ninja lietotājs. Platformai nezināmi CID atgriež HTTP 410 Gone — tiem izmantojiet publisku gateway (ipfs.io, dweb.link) vai vispirms izpildiet POST /pin CID uz sava konta.

Caur API (atgriež faila metadatus)

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

Atbilde:

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

Alternatīva: Izmantojiet AWS SDK (S3 saderīgs)

Jau izmantojat S3? Norādiet savu esošo AWS SDK uz https://s3.ipfs.ninja un izmantojiet savu API atslēgu kā akreditācijas datus:

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

Skatiet S3 saderība pilnai dokumentācijai ar Python, Go un migrācijas piemēriem.

Vēlaties tikai klikšķināt? Izmantojiet informācijas paneli

Ja nevēlaties rakstīt kodu, ipfs.ninja/upload pieņem vilkt-un-nomest šādam saturam:

• Jebkurš fails — nometiet to augšupielādes zonā, tas tiek piesprausts un jūs saņemat CID
• Mape — jūsu pārlūkā iepakota UnixFS direktorijā, augšupielādēta kā vienots imports, katram bērnfailam atrisinās /ipfs/{cid}/{subpath}
• .car arhīvs — automātiski atpazīts, saknes CID saglabāts precīzi (skatiet CAR imports)

Pēc augšupielādes faili parādās Failu lapā, kur varat pārdēvēt, pārvietot starp mapēm, iegūt IPFS direktorijas CID visai mapei (snapshot) un konfigurēt katram bucket S3 CORS pārlūka SDK piekļuvei.

Nākamie soļi

• API atsauce — Pilna dokumentācija par visiem galapunktiem, parametriem un kļūdu kodiem.
• S3 saderība — Izmantojiet AWS SDK, lai mijiedarbotos ar IPFS Ninja.
• Veltīti gateway — Iegūstiet privātu gateway, kas apkalpo tikai jūsu failus.