Penyematan

Semat kandungan IPFS sedia ada ke akaun anda. Apabila anda menyemat CID, kluster kami mendapatkan kandungan dari rangkaian IPFS dan memastikan ia kekal tersedia.

Semat mengikut CID

POST /pin

Parameter	Jenis	Diperlukan	Penerangan
cid	string	Ya	Pengecam kandungan IPFS (bermula dengan Qm atau bafy).
description	string	Tidak	Penerangan ringkas untuk rujukan anda.
metadata	object	Tidak	Pasangan kunci-nilai tersuai. Maks 10 kunci. Kunci alfanumerik atau garis bawah, 1-64 aksara. Nilai mestilah rentetan, maks 256 aksara. Jumlah saiz tidak melebihi 4 KB.

Contoh permintaan

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"
    }
  }'

Respons 202 Accepted

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

TIP

Penyematan adalah tak segerak. Respons dikembalikan serta-merta dengan status pinning. Poll endpoint status untuk menyemak kemajuan.

Semak Status Sematan

GET /pin/:cid

Nilai status

Status	Makna
pinning	Kandungan sedang diambil dari rangkaian IPFS.
pinned	Kandungan disemat dan tersedia.
failed	Kandungan tidak dapat ditemui di rangkaian IPFS.