API nuoroda

Visi galiniai taškai, parametrai, užklausų/atsakymų formatai ir klaidų kodai.

Bazinis URL

https://api.ipfs.ninja

Visoms užklausoms reikalingas API raktas per X-Api-Key antraštę. Žiūrėkite Autentifikacija daugiau informacijos.

Galiniai taškai

Metodas	Kelias	Aprašymas	Puslapis
POST	/upload/new	Įkelti failą į IPFS	Failai
GET	/upload/list	Pateikti įkeltų failų sąrašą	Failai
GET	/file/:cid	Gauti failo metaduomenis pagal CID	Failai
PUT	/files/:cid/name	Pervadinti failą	Failai
PUT	/files/:cid/move	Perkelti failą į aplanką	Aplankai
POST	/pin	Prisegti esamą CID iš IPFS tinklo (palaiko swarm-connect užuominas)	Prisegimas
GET	/pin/:cid	Patikrinti prisegimo būseną	Prisegimas
POST	/folders	Sukurti aplanką	Aplankai
GET	/folders	Pateikti aplankų sąrašą	Aplankai
PUT	/folders/:folderId	Atnaujinti aplanką	Aplankai
DELETE	/folders/:folderId	Ištrinti aplanką	Aplankai
POST	/folders/:folderId/snapshot	Padaryti aplanko momentinę nuotrauką (snapshot) į katalogo CID	Aplankai
PUT	/folders/:folderId/cors	Nustatyti per-bucket CORS konfigūraciją	Aplankai
GET	/folders/:folderId/cors	Gauti per-bucket CORS konfigūraciją	Aplankai
DELETE	/folders/:folderId/cors	Pašalinti per-bucket CORS konfigūraciją	Aplankai
GET	/user/profile	Gauti naudotojo profilį	Profilis
POST	/apikeys	Sukurti API raktą	API raktai
GET	/apikeys	Pateikti API raktų sąrašą	API raktai
DELETE	/apikeys/:key	Ištrinti API raktą	API raktai
GET	/analytics	Naudojimo analitika	Analitika
PUT	/gateway-settings	Atnaujinti gateway nustatymus	Gateway
POST	/gateway-tokens	Sukurti gateway tokeną	Gateway
GET	/gateway-tokens	Pateikti gateway tokenų sąrašą	Gateway
DELETE	/gateway-tokens/:prefix	Ištrinti gateway tokeną	Gateway
POST	/upload/signed-url	Generuoti pasirašytą įkėlimo tokeną	Pasirašyti tokenai
GET	/signed-tokens	Pateikti pasirašytų tokenų sąrašą	Pasirašyti tokenai
DELETE	/signed-tokens/:tokenId	Atšaukti pasirašytą tokeną	Pasirašyti tokenai
GET	/image/:cid	Optimizuoti vaizdą iš karto	Vaizdo optimizavimas

CIDv1 pagal numatytuosius nustatymus

Įkėlimai ir prisegimai grąžina modernų CIDv1 (bafk… mažam vienbloko turiniui, bafy… didesniems failams ir katalogams) pagal IPIP-0499 unixfs-v1-2025 profilį. Ankstesnių įkėlimų senesni Qm… CID lieka visiškai išsprendžiami visur — Qm… yra tinkama įvestis bet kuriam galiniam taškui, priimančiam CID.

S3 suderinama API

Naudokite bet kokį AWS SDK failams įkelti ir tvarkyti IPFS Ninja platformoje. Nukreipkite savo S3 klientą į https://s3.ipfs.ninja naudodami savo API raktą kaip kredencialus.

https://s3.ipfs.ninja

S3 operacija	Aprašymas
PutObject	Įkelti failą į IPFS
GetObject	Atsisiųsti failą
HeadObject	Gauti failo metaduomenis
DeleteObject	Atsegti ir ištrinti failą
ListObjectsV2	Pateikti failų sąrašą su prefikso filtravimu
CreateMultipartUpload	Pradėti daugiadalį įkėlimą (iki 5 GB)
UploadPart	Įkelti dalį
CompleteMultipartUpload	Užbaigti daugiadalį įkėlimą
ListBuckets	Pateikti savo gateway sąrašą
CreateBucket	Sukurti gateway (bucket pavadinimai yra globaliai unikalūs — grąžina BucketAlreadyExists, jei pavadinimas užimtas)
DeleteBucket	Ištrinti gateway
PutBucketCors	Konfigūruoti per-bucket CORS taisykles (reikalinga naudojant naršyklės SDK)
GetBucketCors	Perskaityti dabartinę bucket CORS konfigūraciją
DeleteBucketCors	Pašalinti visas CORS taisykles iš bucket

Žiūrėkite S3 suderinamumas pilną dokumentaciją, kodo pavyzdžius ir migracijos vadovus.