Piespraušana

Piespraudiet esošu IPFS saturu savam kontam. Kad piespraužat CID, mūsu klasteris iegūst saturu no IPFS tīkla un uztur to pastāvīgi pieejamu.

Piespraust pēc CID

POST /pin

Parametrs	Tips	Obligāts	Apraksts
cid	string	Jā	IPFS satura identifikators (sākas ar Qm vai bafy).
description	string	Nē	Īss apraksts jūsu atsaucei.
metadata	object	Nē	Pielāgoti atslēgu-vērtību pāri piespraušanai. Maks 10 atslēgas. Atslēgām jābūt alfanumeriskām vai pasvītrojumiem, 1-64 rakstzīmes. Vērtībām jābūt virknēm, maks 256 rakstzīmes katra. Kopējais metadatu izmērs nedrīkst pārsniegt 4 KB.

Pieprasījuma piemērs

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

Atbilde 202 Accepted

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

TIP

Piespraušana ir asinhrona. Atbilde tiek atgriezta nekavējoties ar statusu pinning. Aptaujājiet statusa galapunktu, lai pārbaudītu, kad piespraušana ir pabeigta.

Pārbaudīt piespraušanas statusu

GET /pin/:cid

Parametrs	Tips	Obligāts	Apraksts
cid	string	Jā	CID, kuru pārbaudāt.

Atbilde 200 OK

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

Statusa vērtības

Statuss	Nozīme
pinning	Saturs tiek iegūts no IPFS tīkla. Aptaujājiet vēlreiz pēc dažām sekundēm.
pinned	Saturs ir piesprausts un pieejams caur jūsu kontu un gateway.
failed	Saturs netika atrasts IPFS tīklā. CID var būt nederīgs vai saturs vairs nav pieejams.

Kā piespraušana darbojas

1. Jūs iesniedzat CID caur POST /pin
2. Mūsu IPFS klasteris meklē tīklā mezglus, kuriem ir saturs
3. Klasteris lejupielādē un piespauž saturu lokāli
4. Pēc piespraušanas fails parādās jūsu failu sarakstā un ir pieejams caur gateway
5. Glabātuves izmantošana tiek reģistrēta, kad piespraušana ir pabeigta

WARNING

Piespraušanas laiks ir atkarīgs no faila izmēra un tīkla pieejamības. Mazi faili parasti tiek piesprausti sekundēs. Lieli faili vai reti piesprausts saturs var aizņemt minūtes.

Glabātuve

Piespraustais saturs tiek ieskaitīts jūsu plāna glabātuves limitā. Faila izmērs tiek reģistrēts, kad piespraušana ir pabeigta — jūs varat uzsākt piespraušanu pat ja jūsu glabātuve ir tuvu limitam, bet turpmākās augšupielādes tiks bloķētas, ja piespraušana izraisa limita pārsniegšanu.