Rychlý start

Nahrajte svůj první soubor na IPFS za méně než dvě minuty.

1. Získejte svůj API klíč

Zaregistrujte se na ipfs.ninja pomocí svého účtu Google. Výchozí API klíč je vytvořen automaticky. Přejděte na svou stránku Profil pro zobrazení a správu vašich API klíčů.

WARNING

Poznámka: API klíče nemají expiraci. Můžete vytvořit více klíčů a jednotlivě je odvolat ze stránky Profil.

2. Nahrajte soubor

Odešlete POST požadavek na /upload/new se svým obsahem. Zde je příklad nahrání 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..."

Výchozí formát CIDv1

Nová nahrání produkují moderní CIDv1 (bafk… pro malý jednoblokový obsah, bafy… pro větší soubory a adresáře) podle IPIP-0499. Starší CID Qm… z dřívějších nahrání se stále rozřeší všude — oba formáty fungují jako vstup pro každý endpoint.

API vrátí CID, velikost souboru a přístupové URI:

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

3. Získejte svůj soubor

Přistupte ke svému souboru dvěma způsoby:

Přes IPFS gateway (bez autentizace)

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

TIP

Apex brána https://ipfs.ninja/ipfs/<CID> obsluhuje CID nahrané nebo připnuté libovolným uživatelem IPFS Ninja. CID neznámé platformě vracejí HTTP 410 Gone — pro ně použijte veřejnou bránu (ipfs.io, dweb.link) nebo nejprve proveďte POST /pin CID na svůj účet.

Přes API (vrátí metadata souboru)

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

Odpověď:

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

Alternativa: Použijte AWS SDK (S3-kompatibilní)

Už používáte S3? Nasměrujte svůj stávající AWS SDK na https://s3.ipfs.ninja a jako přihlašovací údaje použijte svůj API klíč:

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í dokumentaci s příklady v Pythonu, Go a průvodci migrací naleznete v S3 kompatibilitě.

Raději klikáte? Použijte řídicí panel

Pokud nechcete psát kód, ipfs.ninja/upload přijímá přetažením:

• Jakýkoli soubor — přetáhněte ho do nahrávací zóny, připne se + získáte CID
• Složku — zabalenou do UnixFS adresáře ve vašem prohlížeči, nahranou jako jeden import, rozřešitelnou na /ipfs/{cid}/{subpath} pro každý podřízený soubor
• Archiv .car — automaticky rozpoznaný, kořenové CID zachováno přesně (viz Import CAR)

Po nahrání se soubory objeví na stránce Soubory, kde je můžete přejmenovat, přesunout mezi složkami, získat IPFS adresářové CID pro celou složku (snapshot) a nakonfigurovat S3 CORS pro jednotlivé buckety kvůli přístupu z prohlížečového SDK.

Další kroky

• Referenční příručka API — Kompletní dokumentace všech endpointů, parametrů a chybových kódů.
• S3 kompatibilita — Použijte AWS SDK k interakci s IPFS Ninja.
• Dedikované gateway — Získejte privátní gateway, která obsluhuje pouze vaše soubory.