Skip to content

Fastgørelse

Fastgør eksisterende IPFS-indhold til din konto. Når du fastgør et CID, henter vores klynge indholdet fra IPFS-netværket og holder det permanent tilgængeligt.

Fastgør via CID

POST /pin

ParameterTypePåkrævetBeskrivelse
cidstringJaIPFS-indholdsidentifikator (starter med Qm eller bafy).
descriptionstringNejKort beskrivelse til din reference.
metadataobjectNejBrugerdefinerede nøgle-værdi-par at vedhæfte til fastgørelsen. Maks 10 nøgler. Nøgler skal være alfanumeriske eller underscore, 1-64 tegn. Værdier skal være strenge, maks 256 tegn hver. Total metadatastørrelse må ikke overstige 4 KB.

Eksempelforespørgsel

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

Svar 202 Accepted

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

TIP

Fastgørelse er asynkron. Svaret returneres øjeblikkeligt med status pinning. Poll statusendpointet for at tjekke, hvornår fastgørelsen er fuldført.

Tjek fastgørelsesstatus

GET /pin/:cid

ParameterTypePåkrævetBeskrivelse
cidstringJaDet CID du tjekker.

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

Statusværdier

StatusBetydning
pinningIndholdet hentes fra IPFS-netværket. Poll igen om et par sekunder.
pinnedIndholdet er fastgjort og tilgængeligt via din konto og gateway.
failedIndholdet kunne ikke findes på IPFS-netværket. CID'et kan være ugyldigt, eller indholdet er ikke længere tilgængeligt.

Hvordan fastgørelse fungerer

  1. Du indsender et CID via POST /pin
  2. Vores IPFS-klynge søger netværket efter noder, der har indholdet
  3. Klyngen downloader og fastgør indholdet lokalt
  4. Når det er fastgjort, vises filen i din filliste og er tilgængelig via gateway
  5. Lagringsforbrug registreres, når fastgørelsen er fuldført

WARNING

Fastgørelsestiden afhænger af filstørrelse og netværkstilgængelighed. Små filer fastgøres typisk på sekunder. Store filer eller sjældent fastgjort indhold kan tage minutter.

Lagring

Fastgjort indhold tæller mod din plans lagergrænse. Filstørrelsen registreres, når fastgørelsen er fuldført — du kan igangsætte en fastgørelse, selvom din lagring er tæt på grænsen, men yderligere uploads blokeres, hvis fastgørelsen gør, at du overskrider den.