Skip to content

Закачане

Закачете съществуващо IPFS съдържание към вашия акаунт. Когато закачите CID, нашият клъстер извлича съдържанието от IPFS мрежата и го поддържа постоянно достъпно.

Закачане по CID

POST /pin

ПараметърТипЗадължителенОписание
cidstringДаIPFS идентификатор на съдържанието (започва с Qm или bafy).
descriptionstringНеКратко описание за ваша справка.
metadataobjectНеПотребителски двойки ключ-стойност за прикачване. Макс. 10 ключа. Ключовете трябва да са буквено-цифрови или долна черта, 1-64 знака. Стойностите трябва да са низове, макс. 256 знака. Общият размер на метаданните не трябва да надвишава 4 KB.

Пример за заявка

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

Закачането е асинхронно. Отговорът се връща незабавно със статус pinning. За проверка на завършването на закачането проверявайте крайната точка за статус.

Проверка на статуса на закачане

GET /pin/:cid

ПараметърТипЗадължителенОписание
cidstringДаCID-ът, който проверявате.

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

Стойности на статуса

Status
pinningСъдържанието се извлича от IPFS мрежата. Проверете отново след няколко секунди.
pinnedСъдържанието е закачено и достъпно чрез вашия акаунт и gateway.
failedСъдържанието не може да бъде намерено в IPFS мрежата. CID-ът може да е невалиден или съдържанието вече не е достъпно.

Как работи закачането

  1. Изпращате CID чрез POST /pin
  2. Нашият IPFS клъстер търси в мрежата възли, които имат съдържанието
  3. Клъстерът изтегля и закача съдържанието локално
  4. След закачане файлът се появява в списъка ви с файлове и е достъпен чрез gateway
  5. Използването на съхранение се записва при завършване на закачането

WARNING

Времето за закачане зависи от размера на файла и наличността в мрежата. Малки файлове обикновено се закачат за секунди. Големи файлове или рядко закачано съдържание може да отнеме минути.

Съхранение

Закаченото съдържание се отчита в лимита за съхранение на вашия план. Размерът на файла се записва при завършване на закачането — можете да инициирате закачане дори ако съхранението ви е близо до лимита, но следващите качвания ще бъдат блокирани, ако закачането причини превишаването му.