Kiinnitys

Kiinnitä olemassa olevaa IPFS-sisältöä tilillesi. Kun kiinnität CID:n, klusterimme hakee sisällön IPFS-verkosta ja pitää sen pysyvästi saatavilla.

Kiinnitä CID:llä

POST /pin

Parametri	Tyyppi	Pakollinen	Kuvaus
cid	string	Kyllä	IPFS-sisältötunniste (alkaa Qm tai bafy).
description	string	Ei	Lyhyt kuvaus viitteeksesi.
metadata	object	Ei	Mukautetut avain-arvo-parit kiinnitykseen liitettäväksi. Enintään 10 avainta. Avainten on oltava aakkosnumeerisia tai alaviivoja, 1-64 merkkiä. Arvojen on oltava merkkijonoja, enintään 256 merkkiä kukin. Metatietojen kokonaiskoko ei saa ylittää 4 KB.

Esimerkkipyyntö

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

Vastaus 202 Accepted

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

TIP

Kiinnitys on asynkroninen. Vastaus palautetaan välittömästi tilalla pinning. Kysy tilapäätepistettä tarkistaaksesi milloin kiinnitys on valmis.

Tarkista kiinnityksen tila

GET /pin/:cid

Parametri	Tyyppi	Pakollinen	Kuvaus
cid	string	Kyllä	Tarkistettava CID.

Vastaus 200 OK

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

Tila-arvot

Tila	Merkitys
pinning	Sisältöä haetaan IPFS-verkosta. Kysy uudelleen muutaman sekunnin kuluttua.
pinned	Sisältö on kiinnitetty ja saatavilla tilisi ja gatewayn kautta.
failed	Sisältöä ei löytynyt IPFS-verkosta. CID voi olla virheellinen tai sisältö ei ole enää saatavilla.

Miten kiinnitys toimii

1. Lähetät CID:n POST /pin -pyynnöllä
2. IPFS-klusterimme etsii verkosta solmuja, joilla on sisältö
3. Klusteri lataa ja kiinnittää sisällön paikallisesti
4. Kiinnityksen jälkeen tiedosto näkyy tiedostolistallasi ja on saatavilla gatewayn kautta
5. Tallennustilan käyttö kirjataan kiinnityksen valmistuttua

WARNING

Kiinnitysaika riippuu tiedostokoosta ja verkon saatavuudesta. Pienet tiedostot kiinnittyvät tyypillisesti sekunneissa. Suuret tiedostot tai harvoin kiinnitetty sisältö voi viedä minuutteja.

Tallennus

Kiinnitetty sisältö lasketaan suunnitelmasi tallennusrajaan. Tiedostokoko kirjataan kiinnityksen valmistuttua — voit aloittaa kiinnityksen vaikka tallennustilasi olisi lähellä rajaa, mutta lisälataukset estetään jos kiinnitys aiheuttaa rajan ylittymisen.