Připínání

Připněte existující IPFS obsah ke svému účtu. Když připnete CID, náš cluster načte obsah ze sítě IPFS a trvale ho udržuje dostupný.

Připnout podle CID

POST /pin

Parametr	Typ	Povinný	Popis
cid	string	Ano	IPFS identifikátor obsahu (začíná Qm nebo bafy).
description	string	Ne	Krátký popis pro vaši referenci.
metadata	object	Ne	Vlastní páry klíč-hodnota k připojení k připnutí. Max 10 klíčů. Klíče musí být alfanumerické nebo podtržítko, 1-64 znaků. Hodnoty musí být řetězce, max 256 znaků. Celková velikost metadat nesmí přesáhnout 4 KB.

Příklad požadavku

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

Připínání je asynchronní. Odpověď se vrátí okamžitě se stavem pinning. Pro kontrolu dokončení připínání dotazujte endpoint stavu.

Kontrola stavu připnutí

GET /pin/:cid

Parametr	Typ	Povinný	Popis
cid	string	Ano	CID, který 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 se načítá ze sítě IPFS. Dotazujte se znovu za několik sekund.
pinned	Obsah je připnut a dostupný přes váš účet a gateway.
failed	Obsah nebyl nalezen v síti IPFS. CID může být neplatný nebo obsah již není dostupný.

Jak připínání funguje

1. Odešlete CID přes POST /pin
2. Náš IPFS cluster vyhledá v síti uzly, které mají obsah
3. Cluster stáhne a připne obsah lokálně
4. Po připnutí se soubor objeví ve vašem seznamu souborů a je přístupný přes gateway
5. Využití úložiště se zaznamenává po dokončení připnutí

WARNING

Doba připínání závisí na velikosti souboru a dostupnosti sítě. Malé soubory se typicky připnou za sekundy. Velké soubory nebo zřídka připínaný obsah může trvat minuty.

Úložiště

Připnutý obsah se počítá do limitu úložiště vašeho plánu. Velikost souboru se zaznamenává po dokončení připínání — můžete zahájit připnutí i když je vaše úložiště blízko limitu, ale další nahrávání budou blokována, pokud připnutí způsobí jeho překročení.