Pinning

I-pin ang umiiral na IPFS content sa iyong account. Kapag nag-pin ka ng CID, kinukuha ng aming cluster ang nilalaman mula sa IPFS network at pinapanatili itong permanenteng available.

Pin gamit ang CID

POST /pin

Parameter	Uri	Kinakailangan	Paglalarawan
cid	string	Oo	IPFS content identifier (nagsisimula sa Qm o bafy).
description	string	Hindi	Maikling paglalarawan para sa iyong reference.
metadata	object	Hindi	Custom key-value pairs na ila-attach sa pin. Max 10 key. Keys ay dapat alphanumeric o underscore, 1-64 character. Values ay dapat string, max 256 character bawat isa. Kabuuang metadata size ay hindi dapat lumampas sa 4 KB.

Halimbawang request

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

Response 202 Accepted

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

TIP

Ang pinning ay asynchronous. Agad na nagbabalik ang response na may status na pinning. I-poll ang status endpoint para malaman kung tapos na.

Suriin ang Pin Status

GET /pin/:cid

Response 200 OK

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

Mga Status value

Status	Kahulugan
pinning	Kinukuha ang nilalaman mula sa IPFS network. I-poll ulit sa ilang segundo.
pinned	Naka-pin na at available sa pamamagitan ng iyong account at gateway.
failed	Hindi nahanap ang nilalaman sa IPFS network.