การปักหมุด

ปักหมุดเนื้อหา IPFS ที่มีอยู่ในบัญชีของคุณ เมื่อคุณปักหมุด CID คลัสเตอร์ของเราจะดึงเนื้อหาจากเครือข่าย IPFS และเก็บไว้อย่างถาวร

ปักหมุดด้วย CID

POST /pin

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
cid	string	ใช่	ตัวระบุเนื้อหา IPFS (เริ่มต้นด้วย Qm หรือ bafy)
description	string	ไม่	คำอธิบายสั้นๆ สำหรับอ้างอิง
metadata	object	ไม่	คู่คีย์-ค่าที่กำหนดเอง สูงสุด 10 คีย์ คีย์ต้องเป็นตัวอักษรและตัวเลขหรือขีดล่าง 1-64 ตัวอักษร ค่าต้องเป็นสตริง สูงสุด 256 ตัวอักษร ขนาดรวมไม่เกิน 4 KB

ตัวอย่างคำขอ

curl -X POST https://api.ipfs.ninja/pin \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "description": "NFT metadata",
    "metadata": {
      "collection": "my-nfts",
      "token_id": "42"
    }
  }'

การตอบกลับ 202 Accepted

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinning",
  "description": "NFT metadata",
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

TIP

การปักหมุดเป็นแบบอะซิงโครนัส การตอบกลับจะส่งคืนทันทีพร้อมสถานะ pinning สอบถาม endpoint สถานะเพื่อตรวจสอบเมื่อการปักหมุดเสร็จสิ้น

ตรวจสอบสถานะการปักหมุด

GET /pin/:cid

การตอบกลับ 200 OK

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinned",
  "sizeMB": 0.042,
  "fileName": "NFT metadata",
  "pinnedAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

ค่าสถานะ

สถานะ	ความหมาย
pinning	กำลังดึงเนื้อหาจากเครือข่าย IPFS สอบถามอีกครั้งในไม่กี่วินาที
pinned	เนื้อหาถูกปักหมุดและพร้อมใช้งานผ่านบัญชีและ gateway ของคุณ
failed	ไม่พบเนื้อหาในเครือข่าย IPFS CID อาจไม่ถูกต้องหรือเนื้อหาไม่มีแล้ว

วิธีการทำงานของการปักหมุด

1. คุณส่ง CID ผ่าน POST /pin
2. คลัสเตอร์ IPFS ของเราค้นหาเครือข่ายสำหรับโหนดที่มีเนื้อหา
3. คลัสเตอร์ดาวน์โหลดและปักหมุดเนื้อหาในเครื่อง
4. เมื่อปักหมุดแล้ว ไฟล์จะปรากฏในรายการไฟล์ของคุณและเข้าถึงได้ผ่าน gateway
5. การใช้พื้นที่จัดเก็บจะถูกบันทึกเมื่อการปักหมุดเสร็จสิ้น

WARNING

เวลาปักหมุดขึ้นอยู่กับขนาดไฟล์และความพร้อมของเครือข่าย ไฟล์ขนาดเล็กมักปักหมุดได้ในไม่กี่วินาที ไฟล์ขนาดใหญ่หรือเนื้อหาที่ถูกปักหมุดน้อยอาจใช้เวลาหลายนาที

พื้นที่จัดเก็บ

เนื้อหาที่ปักหมุดจะนับรวมในขีดจำกัดพื้นที่จัดเก็บของแผนคุณ ขนาดไฟล์จะถูกบันทึกเมื่อการปักหมุดเสร็จสิ้น