Skip to content

Fixacio

Fixeu contingut IPFS existent al vostre compte. Quan fixeu un CID, el nostre cluster obte el contingut de la xarxa IPFS i el mante permanentment disponible.

Fixar per CID

POST /pin

ParametreTipusRequeritDescripcio
cidstringSiIdentificador de contingut IPFS (comenca amb Qm o bafy).
descriptionstringNoDescripcio breu.
metadataobjectNoParells clau-valor personalitzats. Max 10 claus.

Exemple de sol·licitud

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

Resposta 202 Accepted

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

TIP

La fixacio es asincrona. La resposta retorna immediatament amb estat pinning. Feu polling a l'endpoint d'estat.

Comprovar Estat

GET /pin/:cid

Valors d'estat

EstatSignificat
pinningObtenint contingut de la xarxa IPFS.
pinnedFixat i disponible.
failedNo s'ha pogut trobar el contingut a la xarxa IPFS.