Festing

Fest eksisterende IPFS-innhold til kontoen din. Når du fester et CID, henter klyngen vår innholdet fra IPFS-nettverket og holder det permanent tilgjengelig.

Fest via CID

POST /pin

Parameter	Type	Påkrevd	Beskrivelse
cid	string	Ja	IPFS-innholdsidentifikator (starter med Qm eller bafy).
description	string	Nei	Kort beskrivelse for din referanse.
metadata	object	Nei	Egendefinerte nøkkel-verdi-par å legge ved festingen. Maks 10 nøkler. Nøkler må være alfanumeriske eller understrek, 1-64 tegn. Verdier må være strenger, maks 256 tegn hver. Total metadatastørrelse må ikke overstige 4 KB.

Eksempelforespørsel

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

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

TIP

Festing er asynkron. Svaret returneres umiddelbart med status pinning. Poll statusendepunktet for å sjekke når festingen er fullført.

Sjekk festingsstatus

GET /pin/:cid

Parameter	Type	Påkrevd	Beskrivelse
cid	string	Ja	CID-en du sjekker.

Svar 200 OK

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

Statusverdier

Status	Betydning
pinning	Innholdet hentes fra IPFS-nettverket. Poll igjen om noen sekunder.
pinned	Innholdet er festet og tilgjengelig via kontoen din og gatewayen.
failed	Innholdet kunne ikke finnes på IPFS-nettverket. CID-en kan være ugyldig eller innholdet er ikke lenger tilgjengelig.

Hvordan festing fungerer

1. Du sender et CID via POST /pin
2. IPFS-klyngen vår søker nettverket etter noder som har innholdet
3. Klyngen laster ned og fester innholdet lokalt
4. Når det er festet, vises filen i fillisten din og er tilgjengelig via gatewayen
5. Lagringsbruk registreres når festingen er fullført

WARNING

Festingstiden avhenger av filstørrelse og nettverkstilgjengelighet. Små filer festes vanligvis på sekunder. Store filer eller sjelden festet innhold kan ta minutter.

Lagring

Festet innhold teller mot planens lagringsgrense. Filstørrelsen registreres når festingen er fullført — du kan starte en festing selv om lagringen din er nær grensen, men ytterligere opplastinger blokkeres hvis festingen gjør at du overstiger den.