Mabilis na Pagsisimula

I-upload ang iyong unang file sa IPFS sa loob ng mas mababa sa dalawang minuto.

1. Kunin ang iyong API key

Mag-sign up sa ipfs.ninja gamit ang iyong Google account. Awtomatikong gagawa ng default na API key. Pumunta sa iyong Profile page para makita at pamahalaan ang iyong mga API key.

WARNING

Paalala: Hindi nag-e-expire ang mga API key. Maaari kang gumawa ng maraming key at i-revoke ang bawat isa mula sa iyong Profile page.

2. Mag-upload ng file

Magpadala ng POST request sa /upload/new kasama ang iyong content. Narito ang isang halimbawa ng pag-upload ng JSON object:

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

Ang mga bagong upload ay gumagawa ng modernong CIDv1 (bafk… para sa maliit na single-block na nilalaman, bafy… para sa mas malalaking file at directory) ayon sa IPIP-0499. Ang legacy Qm… na mga CID mula sa mga naunang upload ay nire-resolve pa rin saanman — parehong format ay gumagana bilang input sa bawat endpoint.

Ibinabalik ng API ang CID, laki ng file, at access URI:

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

3. Kunin ang iyong file

I-access ang iyong file sa dalawang paraan:

Sa pamamagitan ng IPFS gateway (hindi kailangan ng auth)

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

TIP

Ang apex gateway https://ipfs.ninja/ipfs/<CID> ay nagsisilbi ng mga CID na na-upload o na-pin ng kahit sinong user ng IPFS Ninja. Ang mga CID na hindi kilala sa platform ay nagbabalik ng HTTP 410 Gone — para sa mga iyon, gumamit ng pampublikong gateway (ipfs.io, dweb.link) o mag-POST /pin muna ng CID sa iyong account.

Sa pamamagitan ng API (nagbabalik ng file metadata)

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

Response:

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

Alternatibo: Gamitin ang AWS SDK (S3-compatible)

Gumagamit ka na ba ng S3? Ituro ang iyong kasalukuyang AWS SDK sa https://s3.ipfs.ninja at gamitin ang iyong API key bilang mga kredensyal:

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

Tingnan ang S3 Compatibility para sa buong dokumentasyon na may mga halimbawa sa Python, Go, at migration.

Mas gusto mong mag-click? Gamitin ang Dashboard

Kung ayaw mong sumulat ng code, tumatanggap ang ipfs.ninja/upload ng drag-and-drop para sa:

• Anumang file — i-drop ito sa upload zone, mapi-pin at makukuha mo ang CID
• Isang folder — pinapackage sa isang UnixFS directory sa iyong browser, ini-upload bilang isang solong import, nire-resolve sa /ipfs/{cid}/{subpath} para sa bawat child file
• Isang .car archive — awtomatikong nade-detect, eksaktong napapanatili ang root CID (tingnan ang CAR Import)

Kapag na-upload na, lumalabas ang mga file sa Files page kung saan maaari mong palitan ng pangalan, ilipat sa pagitan ng mga folder, kumuha ng IPFS directory CID para sa buong folder (snapshot), at i-configure ang per-bucket na S3 CORS para sa browser SDK access.

Mga susunod na hakbang

• API Reference — Kumpletong dokumentasyon para sa lahat ng endpoint, parameter, at error code.
• S3 Compatibility — Gamitin ang AWS SDK para makipag-ugnayan sa IPFS Ninja.
• Dedicated Gateways — Kumuha ng pribadong gateway na nagse-serve lang ng iyong mga file.