Brzi početak

Prenesite svoju prvu datoteku na IPFS za manje od dvije minute.

1. Nabavite svoj API ključ

Registrirajte se na ipfs.ninja sa svojim Google računom. Zadani API ključ automatski se kreira. Idite na svoju stranicu Profil za pregled i upravljanje vašim API ključevima.

WARNING

Napomena: API ključevi nemaju rok trajanja. Možete kreirati više ključeva i pojedinačno ih opozvati sa stranice Profil.

2. Prenesite datoteku

Pošaljite POST zahtjev na /upload/new sa svojim sadržajem. Evo primjera prijenosa JSON objekta:

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 prema zadanim postavkama

Novi prijenosi generiraju moderni CIDv1 (bafk… za manji sadržaj u jednom bloku, bafy… za veće datoteke i direktorije) sukladno IPIP-0499. Stariji Qm… CID-ovi iz ranijih prijenosa i dalje se razrješavaju posvuda — oba formata rade kao ulaz za svaki endpoint.

API vraća CID, veličinu datoteke i pristupne URI-je:

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

3. Dohvatite svoju datoteku

Pristupite svojoj datoteci na dva načina:

Putem IPFS gatewaya (bez potrebe za autentifikacijom)

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

TIP

Apex pristupnik https://ipfs.ninja/ipfs/<CID> poslužuje CID-ove prenesene ili prikvačene od bilo kojeg korisnika IPFS Ninja. CID-ovi nepoznati platformi vraćaju HTTP 410 Gone — za njih koristite javni pristupnik (ipfs.io, dweb.link) ili prvo izvršite POST /pin CID-a na svoj račun.

Putem API-ja (vraća metapodatke datoteke)

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

Odgovor:

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

Alternativa: koristite AWS SDK (kompatibilno s S3)

Već koristite S3? Usmjerite svoj postojeći AWS SDK na https://s3.ipfs.ninja i upotrijebite svoj API ključ kao vjerodajnice:

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

Pogledajte S3 kompatibilnost za potpunu dokumentaciju s primjerima u Pythonu, Go-u i migracijskim primjerima.

Više volite klikanje? Koristite nadzornu ploču

Ako radije ne biste pisali kod, ipfs.ninja/upload prihvaća povlačenje i ispuštanje (drag-and-drop) za:

• Bilo koju datoteku — ispustite je u zonu za prijenos, biva prikvačena i dobivate CID
• Mapu — pakira se u UnixFS direktorij u vašem pregledniku, prenosi se kao jedan uvoz, razrješava se na /ipfs/{cid}/{subpath} za svaku podređenu datoteku
• .car arhivu — automatski prepoznata, korijenski CID se čuva točno (pogledajte Uvoz CAR datoteka)

Nakon prijenosa, datoteke se pojavljuju na stranici Datoteke gdje ih možete preimenovati, premjestiti između mapa, dobiti CID direktorija za cijelu mapu (snimka), te konfigurirati S3 CORS po bucketu za pristup putem browser SDK-a.

Sljedeći koraci

• Referenca API-ja — Kompletna dokumentacija svih endpointova, parametara i kodova grešaka.
• S3 kompatibilnost — Koristite AWS SDK za interakciju s IPFS Ninja.
• Namjenski gatewayevi — Nabavite privatni gateway koji služi samo vaše datoteke.