Prisegimas

Prisekite esamą IPFS turinį prie savo paskyros. Kai prisegate CID, mūsų klasteris gauna turinį iš IPFS tinklo ir laiko jį nuolat prieinamą.

Prisegti pagal CID

POST /pin

Parametras	Tipas	Privalomas	Aprašymas
cid	string	Taip	IPFS turinio identifikatorius (prasideda Qm arba bafy).
description	string	Ne	Trumpas aprašymas jūsų nuorodai.
metadata	object	Ne	Pritaikyti rakto-reikšmės poros pridėti prie prisegimo. Maks. 10 raktų. Raktai turi būti raidiniai-skaitiniai arba pabraukimas, 1-64 simboliai. Reikšmės turi būti eilutės, maks. 256 simbolių kiekviena. Bendras metaduomenų dydis negali viršyti 4 KB.

Užklausos pavyzdys

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

Atsakymas 202 Accepted

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

TIP

Prisegimas yra asinchroninis. Atsakymas grąžinamas iš karto su būsena pinning. Apklauskite būsenos galinį tašką, kad patikrintumėte, kada prisegimas baigtas.

Patikrinti prisegimo būseną

GET /pin/:cid

Parametras	Tipas	Privalomas	Aprašymas
cid	string	Taip	CID, kurį tikrinate.

Atsakymas 200 OK

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

Būsenos reikšmės

Būsena	Reikšmė
pinning	Turinys gaunamas iš IPFS tinklo. Apklauskite dar kartą po kelių sekundžių.
pinned	Turinys prisegtas ir prieinamas per jūsų paskyrą ir gateway.
failed	Turinio nepavyko rasti IPFS tinkle. CID gali būti neteisingas arba turinys nebeprieinamas.

Kaip prisegimas veikia

1. Pateikiate CID per POST /pin
2. Mūsų IPFS klasteris ieško tinkle mazgų, turinčių turinį
3. Klasteris atsisiunčia ir prisega turinį lokaliai
4. Prisegus, failas rodomas jūsų failų sąraše ir prieinamas per gateway
5. Saugyklos naudojimas registruojamas prisegimui pasibaigus

WARNING

Prisegimo laikas priklauso nuo failo dydžio ir tinklo prieinamumo. Maži failai paprastai prisegami per sekundes. Dideli failai ar retai prisegtas turinys gali užtrukti minutes.

Saugykla

Prisegtas turinys skaičiuojamas į jūsų plano saugyklos ribą. Failo dydis registruojamas prisegimui pasibaigus — galite pradėti prisegimą net jei saugykla artėja prie ribos, bet tolesni įkėlimai bus blokuojami, jei prisegimas sukels ribos viršijimą.