Skip to content

Fixare

Fixați conținut IPFS existent în contul dvs. Când fixați un CID, clusterul nostru preia conținutul din rețeaua IPFS și îl menține disponibil permanent.

Fixare după CID

POST /pin

ParametruTipObligatoriuDescriere
cidstringDaIdentificator de conținut IPFS (începe cu Qm sau bafy).
descriptionstringNuDescriere scurtă pentru referința dvs.
metadataobjectNuPerechi cheie-valoare personalizate de atașat la fixare. Max 10 chei. Cheile trebuie să fie alfanumerice sau underscore, 1-64 caractere. Valorile trebuie să fie șiruri, max 256 caractere. Dimensiunea totală a metadatelor nu trebuie să depășească 4 KB.

Exemplu de cerere

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

Response 202 Accepted

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

TIP

Fixarea este asincronă. Răspunsul revine imediat cu starea pinning. Interogați endpoint-ul de stare pentru a verifica finalizarea fixării.

Verificarea stării de fixare

GET /pin/:cid

ParametruTipObligatoriuDescriere
cidstringDaCID-ul pe care îl verificați.

Response 200 OK

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

Valori de stare

Status
pinningConținutul este preluat din rețeaua IPFS. Interogați din nou în câteva secunde.
pinnedConținutul este fixat și disponibil prin contul și gateway-ul dvs.
failedConținutul nu a putut fi găsit în rețeaua IPFS. CID-ul poate fi invalid sau conținutul nu mai este disponibil.

Cum funcționează fixarea

  1. Trimiteți un CID prin POST /pin
  2. Clusterul nostru IPFS caută în rețea noduri care au conținutul
  3. Clusterul descarcă și fixează conținutul local
  4. Odată fixat, fișierul apare în lista dvs. de fișiere și este accesibil prin gateway
  5. Utilizarea stocării este înregistrată la finalizarea fixării

WARNING

Timpul de fixare depinde de dimensiunea fișierului și de disponibilitatea rețelei. Fișierele mici se fixează de obicei în câteva secunde. Fișierele mari sau conținutul rar fixat poate dura minute.

Stocare

Conținutul fixat se numără în limita de stocare a planului dvs. Dimensiunea fișierului este înregistrată la finalizarea fixării -- puteți iniția o fixare chiar dacă stocarea dvs. este aproape de limită, dar încărcările ulterioare vor fi blocate dacă fixarea vă determină să o depășiți.