เริ่มต้นอย่างรวดเร็ว

อัปโหลดไฟล์แรกของคุณไปยัง IPFS ในเวลาไม่ถึงสองนาที

1. รับ API key ของคุณ

สมัครที่ ipfs.ninja ด้วยบัญชี Google ของคุณ API key เริ่มต้นจะถูกสร้างโดยอัตโนมัติ ไปที่หน้าโปรไฟล์ของคุณเพื่อดูและจัดการ API key ของคุณ

WARNING

หมายเหตุ: API key ไม่หมดอายุ คุณสามารถสร้างคีย์หลายตัวและเพิกถอนแต่ละตัวได้จากหน้าโปรไฟล์ของคุณ

2. อัปโหลดไฟล์

ส่งคำขอ POST ไปยัง /upload/new พร้อมเนื้อหาของคุณ นี่คือตัวอย่างการอัปโหลดอ็อบเจกต์ 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://QmExampleCID..."
    },
    "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://QmExampleCID..."
    },
    description: "NFT metadata"
  })
});

const data = await response.json();
console.log(data.cid);       // "QmXmCX9S6ANV..."
console.log(data.uris.url);  // "https://ipfs.ninja/ipfs/QmXmCX9S6ANV..."

API จะส่งคืน CID, ขนาดไฟล์ และ URI สำหรับการเข้าถึง:

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

3. เรียกดูไฟล์ของคุณ

เข้าถึงไฟล์ของคุณได้สองวิธี:

ผ่าน IPFS gateway (สาธารณะ, ไม่ต้องยืนยันตัวตน)

curl https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN

ผ่าน API (ส่งคืน metadata ของไฟล์)

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

การตอบกลับ:

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

ขั้นตอนถัดไป

• เอกสารอ้างอิง API — เอกสารฉบับเต็มสำหรับ endpoint, พารามิเตอร์ และรหัสข้อผิดพลาดทั้งหมด
• Gateway เฉพาะ — รับ gateway ส่วนตัวที่ให้บริการเฉพาะไฟล์ของคุณ มีให้ในแผน Nirvana