Kinnitamine

Kinnitage olemasolev IPFS-sisu oma kontole. Kui kinnitate CID-i, otsib meie klaster sisu IPFS-võrgust ja hoiab seda püsivalt kättesaadavana.

Kinnitage CID järgi

POST /pin

Parameeter	Tüüp	Nõutud	Kirjeldus
cid	string	Jah	IPFS sisuidentifikaator (algab Qm või bafy).
description	string	Ei	Lühikirjeldus teie viitamiseks.
metadata	object	Ei	Kohandatud võtme-väärtus paarid kinnitusele lisamiseks. Maks 10 võtit. Võtmed peavad olema tähtnumbrilised või allkriips, 1-64 tähemärki. Väärtused peavad olema stringid, maks 256 tähemärki igaüks. Metaandmete kogusuurus ei tohi ületada 4 KB.

Näidispäring

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

Vastus 202 Accepted

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

TIP

Kinnitamine on asünkroonne. Vastus tagastatakse kohe olekuga pinning. Küsige oleku lõpp-punkti, et kontrollida, millal kinnitamine on lõpetatud.

Kontrollige kinnitamise olekut

GET /pin/:cid

Parameeter	Tüüp	Nõutud	Kirjeldus
cid	string	Jah	CID, mida kontrollite.

Vastus 200 OK

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

Oleku väärtused

Olek	Tähendus
pinning	Sisu otsitakse IPFS-võrgust. Küsige uuesti mõne sekundi pärast.
pinned	Sisu on kinnitatud ja kättesaadav teie konto ja gateway kaudu.
failed	Sisu ei leitud IPFS-võrgust. CID võib olla kehtetu või sisu pole enam kättesaadav.

Kuidas kinnitamine toimib

1. Esitate CID POST /pin kaudu
2. Meie IPFS klaster otsib võrgust sõlmi, millel on sisu
3. Klaster laadib sisu alla ja kinnitab selle kohapeal
4. Pärast kinnitamist ilmub fail teie failide loendis ja on kättesaadav gateway kaudu
5. Salvestusruumi kasutus registreeritakse kinnitamise lõppedes

WARNING

Kinnitamise aeg sõltub faili suurusest ja võrgu kättesaadavusest. Väikesed failid kinnituvad tavaliselt sekunditega. Suured failid või harva kinnitatud sisu võib võtta minuteid.

Salvestus

Kinnitatud sisu arvestatakse teie plaani salvestuspiiri hulka. Faili suurus registreeritakse kinnitamise lõppedes — saate algatada kinnitamise isegi kui salvestusruum on piiri lähedal, kuid edasised üleslaadimised blokeeritakse, kui kinnitus põhjustab piiri ületamise.