Справка за API

Всички крайни точки, параметри, формати на заявки/отговори и кодове за грешки.

Основен URL

https://api.ipfs.ninja

Всички заявки изискват API ключ чрез заглавието X-Api-Key. Вижте Удостоверяване за подробности.

Крайни точки

Метод	Път	Описание	Страница
POST	/upload/new	Качване на файл в IPFS	Файлове
GET	/upload/list	Списък на качени файлове	Файлове
GET	/file/:cid	Получаване на метаданни на файл по CID	Файлове
PUT	/files/:cid/name	Преименуване на файл	Файлове
PUT	/files/:cid/move	Преместване на файл в папка	Папки
POST	/pin	Закачане на съществуващ CID от IPFS мрежата (поддържа подсказки за swarm-connect)	Закачане
GET	/pin/:cid	Проверка на статуса на закачане	Закачане
POST	/folders	Създаване на папка	Папки
GET	/folders	Списък на папки	Папки
PUT	/folders/:folderId	Актуализиране на папка	Папки
DELETE	/folders/:folderId	Изтриване на папка	Папки
POST	/folders/:folderId/snapshot	Снимка на папка в CID на директория	Папки
PUT	/folders/:folderId/cors	Задаване на CORS конфигурация за конкретен bucket	Папки
GET	/folders/:folderId/cors	Получаване на CORS конфигурация за конкретен bucket	Папки
DELETE	/folders/:folderId/cors	Премахване на CORS конфигурация за конкретен bucket	Папки
GET	/user/profile	Получаване на потребителски профил	Профил
POST	/apikeys	Създаване на API ключ	API ключове
GET	/apikeys	Списък на API ключове	API ключове
DELETE	/apikeys/:key	Изтриване на API ключ	API ключове
GET	/analytics	Аналитика на използване	Аналитика
PUT	/gateway-settings	Актуализиране на настройки на gateway	Gateway-и
POST	/gateway-tokens	Създаване на токен за gateway	Gateway-и
GET	/gateway-tokens	Списък на токени за gateway	Gateway-и
DELETE	/gateway-tokens/:prefix	Изтриване на токен за gateway	Gateway-и
POST	/upload/signed-url	Генериране на подписан токен за качване	Подписани токени
GET	/signed-tokens	Списък на подписани токени	Подписани токени
DELETE	/signed-tokens/:tokenId	Отмяна на подписан токен	Подписани токени
GET	/image/:cid	Оптимизация на изображение в движение	Оптимизация на изображения

CIDv1 по подразбиране

Качванията и закаченията връщат модерен CIDv1 (bafk… за малко съдържание в един блок, bafy… за по-големи файлове и директории) съгласно профила IPIP-0499 unixfs-v1-2025. По-старите CID-ове Qm… от предишни качвания остават напълно разрешими навсякъде — Qm… е валиден вход за всяка крайна точка, която приема CID.

S3-съвместим API

Използвайте всеки AWS SDK, за да качвате и управлявате файлове в IPFS Ninja. Насочете вашия S3 клиент към https://s3.ipfs.ninja с API ключа си като идентификационни данни.

https://s3.ipfs.ninja

S3 операция	Описание
PutObject	Качване на файл в IPFS
GetObject	Изтегляне на файл
HeadObject	Получаване на метаданни на файл
DeleteObject	Откачане и изтриване на файл
ListObjectsV2	Списък на файлове с филтриране по префикс
CreateMultipartUpload	Стартиране на multipart качване (до 5 GB)
UploadPart	Качване на част
CompleteMultipartUpload	Завършване на multipart качване
ListBuckets	Списък на вашите gateway-и
CreateBucket	Създаване на gateway (имената на bucket-ите са глобално уникални — връща BucketAlreadyExists, ако е заето)
DeleteBucket	Изтриване на gateway
PutBucketCors	Конфигуриране на CORS правила за конкретен bucket (необходимо за използване на SDK в браузър)
GetBucketCors	Четене на текущата CORS конфигурация за bucket
DeleteBucketCors	Премахване на всички CORS правила от bucket

Вижте S3 съвместимост за пълна документация, примерен код и ръководства за миграция.