Pripínanie

Pripnite existujúci IPFS obsah k svojmu účtu. Keď pripnete CID, náš cluster načíta obsah zo siete IPFS a trvalo ho udržiava dostupným.

Pripnúť podľa CID

POST /pin

Parameter	Typ	Povinný	Popis
cid	string	Áno	IPFS identifikátor obsahu (začína Qm alebo bafy).
description	string	Nie	Krátky popis pre vašu referenciu.
metadata	object	Nie	Vlastné páry kľúč-hodnota na pripojenie k pripnutiu. Max 10 kľúčov. Kľúče musia byť alfanumerické alebo podčiarkovník, 1-64 znakov. Hodnoty musia byť reťazce, max 256 znakov. Celková veľkosť metadát nesmie presiahnuť 4 KB.

Príklad požiadavky

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

Pripínanie je asynchrónne. Odpoveď sa vráti okamžite so stavom pinning. Pre kontrolu dokončenia pripnutia dopytujte endpoint stavu.

Kontrola stavu pripnutia

GET /pin/:cid

Parameter	Typ	Povinný	Popis
cid	string	Áno	CID, ktorý kontrolujete.

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

Hodnoty stavu

Status
pinning	Obsah sa načítava zo siete IPFS. Dopytujte sa znova za niekoľko sekúnd.
pinned	Obsah je pripnutý a dostupný cez váš účet a gateway.
failed	Obsah nebol nájdený v sieti IPFS. CID môže byť neplatný alebo obsah už nie je dostupný.

Ako pripínanie funguje

1. Odošlete CID cez POST /pin
2. Náš IPFS cluster vyhľadá v sieti uzly, ktoré majú obsah
3. Cluster stiahne a pripne obsah lokálne
4. Po pripnutí sa súbor objaví vo vašom zozname súborov a je prístupný cez gateway
5. Využitie úložiska sa zaznamenáva po dokončení pripnutia

WARNING

Doba pripínania závisí od veľkosti súboru a dostupnosti siete. Malé súbory sa typicky pripnú za sekundy. Veľké súbory alebo zriedka pripínaný obsah môže trvať minúty.

Úložisko

Pripnutý obsah sa počíta do limitu úložiska vášho plánu. Veľkosť súboru sa zaznamenáva po dokončení pripnutia — môžete začať pripnutie aj keď je vaše úložisko blízko limitu, ale ďalšie nahrávania budú blokované, ak pripnutie spôsobí jeho prekročenie.