Rýchly štart

Nahrajte svoj prvý súbor na IPFS za menej ako dve minúty.

1. Získajte svoj API kľúč

Zaregistrujte sa na ipfs.ninja pomocou svojho účtu Google. Predvolený API kľúč sa vytvorí automaticky. Prejdite na svoju stránku Profil na zobrazenie a správu vašich API kľúčov.

WARNING

Poznámka: API kľúče nemajú expiráciu. Môžete vytvoriť viacero kľúčov a jednotlivo ich odvolať zo stránky Profil.

2. Nahrajte súbor

Odošlite POST požiadavku na /upload/new s vaším obsahom. Tu je príklad nahratia JSON objektu:

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 by default

Nové nahrávania produkujú moderné CIDv1 (bafk… pre malý jednoblokový obsah, bafy… pre väčšie súbory a priečinky) podľa IPIP-0499. Staršie CID Qm… z predchádzajúcich nahrávaní stále rozpoznateľné všade — oba formáty fungujú ako vstup pre každý endpoint.

API vráti CID, veľkosť súboru a prístupové URI:

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

3. Získajte svoj súbor

Pristúpte k svojmu súboru dvoma spôsobmi:

Cez IPFS gateway (bez potreby autentifikácie)

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

TIP

Apex brána https://ipfs.ninja/ipfs/<CID> obsluhuje CID nahrané alebo pripnuté ľubovoľným používateľom IPFS Ninja. CID neznáme platforme vracajú HTTP 410 Gone — pre ne použite verejnú bránu (ipfs.io, dweb.link) alebo najprv vykonajte POST /pin CID na svoj účet.

Cez API (vráti metadáta súboru)

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

Odpoveď:

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

Alternatíva: Použite AWS SDK (S3-kompatibilné)

Už používate S3? Nasmerujte svoj existujúci AWS SDK na https://s3.ipfs.ninja a použite svoj API kľúč ako prihlasovacie údaje:

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

Kompletnú dokumentáciu s príkladmi v Pythone, Go a sprievodcami migráciou nájdete v časti Kompatibilita s S3.

Radšej klikáte? Použite ovládací panel

Ak radšej nepíšete kód, ipfs.ninja/upload prijíma nahrávanie ťahaním a pustením pre:

• Akýkoľvek súbor — pustite ho na nahrávaciu zónu, súbor sa pripne a dostanete jeho CID
• Priečinok — zabalený do UnixFS adresára priamo vo vašom prehliadači, nahraný ako jeden import, dostupný na /ipfs/{cid}/{subpath} pre každý súbor v ňom
• Archív .car — automaticky rozpoznaný, koreňové CID zostane zachované presne (pozri Import CAR)

Po nahraní sa súbory zobrazia na stránke Súbory, kde ich môžete premenovať, presúvať medzi priečinkami, získať CID IPFS adresára pre celý priečinok (snímka) a nakonfigurovať S3 CORS pre jednotlivé buckety kvôli prístupu z prehliadačového SDK.

Ďalšie kroky

• Referenčná príručka API — Kompletná dokumentácia všetkých endpointov, parametrov a chybových kódov.
• Kompatibilita s S3 — Použite AWS SDK na komunikáciu s IPFS Ninja.
• Dedikované gateway — Získajte privátnu gateway, ktorá obsluhuje iba vaše súbory.