Referenca API-ja

Vse končne točke, parametri, formati zahtev/odgovorov in kode napak.

Osnovni URL

https://api.ipfs.ninja

Vse zahteve zahtevajo API ključ prek glave X-Api-Key. Podrobnosti najdete v razdelku Avtentikacija.

Končne točke

Metoda	Pot	Opis	Stran
POST	/upload/new	Nalaganje datoteke na IPFS	Datoteke
GET	/upload/list	Seznam naloženih datotek	Datoteke
GET	/file/:cid	Pridobitev metapodatkov datoteke po CID	Datoteke
PUT	/files/:cid/name	Preimenovanje datoteke	Datoteke
PUT	/files/:cid/move	Premik datoteke v mapo	Mape
POST	/pin	Pripenjanje obstoječega CID iz IPFS omrežja (podpira namige za povezavo v roj)	Pripenjanje
GET	/pin/:cid	Preverjanje stanja pripenjanja	Pripenjanje
POST	/folders	Ustvarjanje mape	Mape
GET	/folders	Seznam map	Mape
PUT	/folders/:folderId	Posodobitev mape	Mape
DELETE	/folders/:folderId	Brisanje mape	Mape
POST	/folders/:folderId/snapshot	Zajem mape v CID direktorija	Mape
PUT	/folders/:folderId/cors	Nastavitev CORS konfiguracije za posamezno vedro	Mape
GET	/folders/:folderId/cors	Pridobitev CORS konfiguracije za posamezno vedro	Mape
DELETE	/folders/:folderId/cors	Odstranitev CORS konfiguracije za posamezno vedro	Mape
GET	/user/profile	Pridobitev uporabniškega profila	Profil
POST	/apikeys	Ustvarjanje API ključa	API ključi
GET	/apikeys	Seznam API ključev	API ključi
DELETE	/apikeys/:key	Brisanje API ključa	API ključi
GET	/analytics	Analitika uporabe	Analitika
PUT	/gateway-settings	Posodobitev nastavitev prehoda	Prehodi
POST	/gateway-tokens	Ustvarjanje žetona prehoda	Prehodi
GET	/gateway-tokens	Seznam žetonov prehoda	Prehodi
DELETE	/gateway-tokens/:prefix	Brisanje žetona prehoda	Prehodi
POST	/upload/signed-url	Ustvarjanje podpisanega žetona za nalaganje	Podpisani žetoni
GET	/signed-tokens	Seznam podpisanih žetonov	Podpisani žetoni
DELETE	/signed-tokens/:tokenId	Preklic podpisanega žetona	Podpisani žetoni
GET	/image/:cid	Optimizacija slike sproti	Optimizacija slik

CIDv1 privzeto

Nalaganja in pripenjanja vrnejo sodobne CIDv1 (bafk… za majhno vsebino z enim blokom, bafy… za večje datoteke in direktorije) po profilu IPIP-0499 unixfs-v1-2025. Starejši CID-i Qm… iz prejšnjih nalaganj ostanejo v celoti razrešljivi povsod — Qm… je veljaven vnos za vsako končno točko, ki sprejema CID.

API, združljiv s S3

Za nalaganje in upravljanje datotek na IPFS Ninja uporabite kateri koli AWS SDK. Usmerite svojega odjemalca S3 na https://s3.ipfs.ninja z API ključem kot poverilnico.

https://s3.ipfs.ninja

Operacija S3	Opis
PutObject	Nalaganje datoteke na IPFS
GetObject	Prenos datoteke
HeadObject	Pridobitev metapodatkov datoteke
DeleteObject	Odpenjanje in brisanje datoteke
ListObjectsV2	Seznam datotek s filtriranjem po predponi
CreateMultipartUpload	Začetek večdelnega nalaganja (do 5 GB)
UploadPart	Nalaganje dela
CompleteMultipartUpload	Zaključek večdelnega nalaganja
ListBuckets	Seznam vaših prehodov
CreateBucket	Ustvarjanje prehoda (imena veder so globalno enolična — vrne BucketAlreadyExists, če je ime že zasedeno)
DeleteBucket	Brisanje prehoda
PutBucketCors	Konfiguracija pravil CORS za posamezno vedro (potrebno za uporabo SDK v brskalniku)
GetBucketCors	Branje trenutne CORS konfiguracije vedra
DeleteBucketCors	Odstranitev vseh pravil CORS z vedra

Za popolno dokumentacijo, primere kode in vodnike za migracijo glejte Združljivost s S3.