Inici Ràpid

Pugeu el vostre primer fitxer a IPFS en menys de dos minuts.

1. Obteniu la vostra API key

Registreu-vos a ipfs.ninja amb el vostre compte de Google. Es crea automàticament una API key per defecte. Aneu a la vostra pàgina de Perfil per veure i gestionar les vostres API key.

WARNING

Nota: Les API key no caduquen. Podeu crear múltiples claus i revocar-les individualment des de la vostra pàgina de Perfil.

2. Pugeu un fitxer

Envieu una sol·licitud POST a /upload/new amb el vostre contingut. Aquí teniu un exemple de pujada d'un objecte JSON:

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 per defecte

Les pujades noves generen CIDv1 modern (bafk… per a contingut petit d'un sol bloc, bafy… per a fitxers i directoris més grans) seguint IPIP-0499. Els CID Qm… heretats de pujades anteriors encara es resolen arreu — ambdós formats funcionen com a entrada per a tots els endpoints.

L'API retorna el CID, la mida del fitxer i els URI d'accés:

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

3. Recupereu el vostre fitxer

Accediu al vostre fitxer de dues maneres:

Mitjançant l'IPFS gateway (sense autenticació)

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

TIP

La passarel·la apex https://ipfs.ninja/ipfs/<CID> serveix CID pujats o fixats per qualsevol usuari d'IPFS Ninja. Els CID desconeguts per a la plataforma retornen HTTP 410 Gone — per a aquests, feu servir un gateway públic (ipfs.io, dweb.link) o feu primer POST /pin del CID al vostre compte.

Mitjançant l'API (retorna metadata del fitxer)

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

Resposta:

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

Alternativa: Utilitzeu l'AWS SDK (compatible amb S3)

Ja feu servir S3? Apunteu el vostre AWS SDK existent a https://s3.ipfs.ninja i utilitzeu la vostra API key com a credencials:

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

Consulteu Compatibilitat S3 per a la documentació completa amb exemples de Python, Go i migració.

Prefereixes fer-ho amb clics? Utilitza el Tauler de control

Si preferiu no escriure codi, ipfs.ninja/upload accepta arrossegar i deixar anar per a:

• Qualsevol fitxer — deixeu-lo anar a la zona de pujada, es fixa i obteniu el CID
• Una carpeta — s'empaqueta en un directori UnixFS al vostre navegador, es puja com una sola importació, es resol a /ipfs/{cid}/{subpath} per a cada fitxer fill
• Un arxiu .car — es detecta automàticament, el CID arrel es preserva exactament (vegeu Importació CAR)

Un cop pujats, els fitxers apareixen a la pàgina de Fitxers on podeu canviar el nom, moure entre carpetes, obtenir un CID de directori IPFS per a tota una carpeta (snapshot), i configurar S3 CORS per bucket per a l'accés des de l'SDK del navegador.

Propers passos

• Referència de l'API — Documentació completa per a tots els endpoints, paràmetres i codis d'error.
• Compatibilitat S3 — Utilitzeu l'AWS SDK per interactuar amb IPFS Ninja.
• Gateways Dedicats — Obteniu un gateway privat que només serveix els vostres fitxers.