Referința API

Toate endpoint-urile, parametrii, formatele cerere/răspuns și codurile de eroare.

URL de bază

https://api.ipfs.ninja

Toate cererile necesită o cheie API prin antetul X-Api-Key. Consultați Autentificare pentru detalii.

Endpoint-uri

Metodă	Cale	Descriere	Pagină
POST	/upload/new	Încărcarea unui fișier pe IPFS	Fișiere
GET	/upload/list	Listarea fișierelor încărcate	Fișiere
GET	/file/:cid	Obținerea metadatelor fișierului după CID	Fișiere
PUT	/files/:cid/name	Redenumirea unui fișier	Fișiere
PUT	/files/:cid/move	Mutarea unui fișier într-un folder	Foldere
POST	/pin	Fixarea unui CID existent din rețeaua IPFS (acceptă indicii de conectare swarm)	Fixare
GET	/pin/:cid	Verificarea stării de fixare	Fixare
POST	/folders	Crearea unui folder	Foldere
GET	/folders	Listarea folderelor	Foldere
PUT	/folders/:folderId	Actualizarea unui folder	Foldere
DELETE	/folders/:folderId	Ștergerea unui folder	Foldere
POST	/folders/:folderId/snapshot	Instantaneu al unui folder într-un CID de director	Foldere
PUT	/folders/:folderId/cors	Configurarea CORS per bucket	Foldere
GET	/folders/:folderId/cors	Obținerea configurației CORS per bucket	Foldere
DELETE	/folders/:folderId/cors	Eliminarea configurației CORS per bucket	Foldere
GET	/user/profile	Obținerea profilului utilizatorului	Profil
POST	/apikeys	Crearea cheii API	Chei API
GET	/apikeys	Listarea cheilor API	Chei API
DELETE	/apikeys/:key	Ștergerea cheii API	Chei API
GET	/analytics	Analize de utilizare	Analize
PUT	/gateway-settings	Actualizarea setărilor gateway	Gateway-uri
POST	/gateway-tokens	Crearea tokenului gateway	Gateway-uri
GET	/gateway-tokens	Listarea tokenurilor gateway	Gateway-uri
DELETE	/gateway-tokens/:prefix	Ștergerea tokenului gateway	Gateway-uri
POST	/upload/signed-url	Generarea tokenului semnat de încărcare	Tokenuri semnate
GET	/signed-tokens	Listarea tokenurilor semnate	Tokenuri semnate
DELETE	/signed-tokens/:tokenId	Revocarea tokenului semnat	Tokenuri semnate
GET	/image/:cid	Optimizarea imaginii din mers	Optimizarea imaginilor

CIDv1 implicit

Încărcările și fixările returnează CIDv1 modern (bafk… pentru conținut mic, cu un singur bloc, bafy… pentru fișiere și directoare mai mari) conform profilului IPIP-0499 unixfs-v1-2025. CID-urile vechi Qm… din încărcările anterioare rămân complet rezolvabile peste tot — Qm… este o intrare validă pentru orice endpoint care acceptă un CID.

API compatibil S3

Folosiți orice SDK AWS pentru a încărca și gestiona fișiere pe IPFS Ninja. Îndreptați clientul dvs. S3 către https://s3.ipfs.ninja folosind cheia API drept credențiale.

https://s3.ipfs.ninja

Operație S3	Descriere
PutObject	Încărcarea unui fișier pe IPFS
GetObject	Descărcarea unui fișier
HeadObject	Obținerea metadatelor fișierului
DeleteObject	Anularea fixării și ștergerea unui fișier
ListObjectsV2	Listarea fișierelor cu filtrare după prefix
CreateMultipartUpload	Pornirea unei încărcări multipart (până la 5 GB)
UploadPart	Încărcarea unei părți
CompleteMultipartUpload	Finalizarea încărcării multipart
ListBuckets	Listarea gateway-urilor dvs.
CreateBucket	Crearea unui gateway (numele bucket-urilor sunt unice global — returnează BucketAlreadyExists dacă este deja folosit)
DeleteBucket	Ștergerea unui gateway
PutBucketCors	Configurarea regulilor CORS per bucket (necesară pentru utilizarea SDK-ului din browser)
GetBucketCors	Citirea configurației CORS curente pentru un bucket
DeleteBucketCors	Eliminarea tuturor regulilor CORS dintr-un bucket

Consultați Compatibilitate S3 pentru documentația completă, exemple de cod și ghiduri de migrare.