Rögzítés

Rögzítsen meglévő IPFS tartalmat a fiókjához. Amikor egy CID-et rögzít, klaszterünk lekéri a tartalmat az IPFS hálózatról és tartósan elérhetővé teszi.

Rögzítés CID alapján

POST /pin

Paraméter	Típus	Kötelező	Leírás
cid	string	Igen	IPFS tartalmazonosító (Qm vagy bafy előtaggal).
description	string	Nem	Rövid leírás az Ön számára.
metadata	object	Nem	Egyéni kulcs-érték párok a rögzítéshez csatolásra. Max 10 kulcs. A kulcsok alfanumerikusak vagy aláhúzás lehetnek, 1-64 karakter. Az értékeknek szövegnek kell lenniük, max 256 karakter. A metaadatok összmérete nem haladhatja meg a 4 KB-ot.

Példa kérés

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

A rögzítés aszinkron. A válasz azonnal visszatér pinning állapottal. A rögzítés befejezésének ellenőrzéséhez kérdezze le az állapot végpontot.

Rögzítési állapot ellenőrzése

GET /pin/:cid

Paraméter	Típus	Kötelező	Leírás
cid	string	Igen	Az ellenőrizendő 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"
  }
}

Állapot értékek

Status
pinning	A tartalom lekérés alatt az IPFS hálózatról. Kérdezze le újra néhány másodperc múlva.
pinned	A tartalom rögzítve van és elérhető a fiókján és gateway-én keresztül.
failed	A tartalom nem található az IPFS hálózaton. A CID érvénytelen lehet, vagy a tartalom már nem elérhető.

Hogyan működik a rögzítés

1. Elküldi a CID-et a POST /pin végpontra
2. IPFS klaszterünk megkeresi a hálózaton a tartalommal rendelkező csomópontokat
3. A klaszter letölti és helyben rögzíti a tartalmat
4. Rögzítés után a fájl megjelenik a fájllistájában és elérhető a gateway-en keresztül
5. A tárhelyhasználat a rögzítés befejezésekor kerül rögzítésre

WARNING

A rögzítés ideje a fájl méretétől és a hálózat elérhetőségétől függ. Kis fájlok jellemzően másodpercek alatt rögzítésre kerülnek. Nagy fájlok vagy ritkán rögzített tartalom percekbe telhet.

Tárhely

A rögzített tartalom beleszámít a csomagja tárhelykorlátjába. A fájlméret a rögzítés befejezésekor kerül rögzítésre -- elindíthat egy rögzítést akkor is, ha a tárhelye közel van a korláthoz, de a további feltöltések blokkolva lesznek, ha a rögzítés miatt túllépi azt.