Pripenjanje

Pripnite obstoječo IPFS vsebino na svoj račun. Ko pripnete CID, naš grozd pridobi vsebino iz IPFS omrežja in jo trajno ohranja dostopno.

Pripenjanje po CID

POST /pin

Parameter	Tip	Obvezno	Opis
cid	string	Da	IPFS identifikator vsebine (začne se z Qm ali bafy).
description	string	Ne	Kratek opis za vašo referenco.
metadata	object	Ne	Prilagojeni pari ključ-vrednost za pripenjanje. Največ 10 ključev. Ključi morajo biti alfanumerični ali podčrtaj, 1-64 znakov. Vrednosti morajo biti nizi, največ 256 znakov. Skupna velikost metapodatkov ne sme presegati 4 KB.

Primer zahteve

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

Pripenjanje je asinhrono. Odgovor se vrne takoj s stanjem pinning. Za preverjanje zaključka pripenjanja poizvedujte končno točko stanja.

Preverjanje stanja pripenjanja

GET /pin/:cid

Parameter	Tip	Obvezno	Opis
cid	string	Da	CID, ki ga preverjate.

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

Vrednosti stanja

Status
pinning	Vsebina se pridobiva iz IPFS omrežja. Poizvedite znova čez nekaj sekund.
pinned	Vsebina je pripeta in dostopna prek vašega računa in prehoda.
failed	Vsebine ni bilo mogoče najti v IPFS omrežju. CID je morda neveljaven ali vsebina ni več na voljo.

Kako pripenjanje deluje

1. Pošljete CID prek POST /pin
2. Naš IPFS grozd poišče vozlišča v omrežju, ki imajo vsebino
3. Grozd prenese in pripne vsebino lokalno
4. Ko je pripeta, se datoteka pojavi v vašem seznamu datotek in je dostopna prek prehoda
5. Uporaba shrambe se zabeleži ob zaključku pripenjanja

WARNING

Čas pripenjanja je odvisen od velikosti datoteke in razpoložljivosti omrežja. Majhne datoteke se običajno pripnejo v sekundah. Velike datoteke ali redko pripeta vsebina lahko traja minute.

Shramba

Pripeta vsebina se šteje v omejitev shrambe vašega načrta. Velikost datoteke se zabeleži ob zaključku pripenjanja — pripenjanje lahko začnete tudi če je vaša shramba blizu omejitve, vendar bodo nadaljnja nalaganja blokirana, če pripenjanje povzroči preseganje.