API viide

Kõik lõpp-punktid, parameetrid, päringu-/vastusevormingud ja veakoodid.

Baas-URL

https://api.ipfs.ninja

Kõik päringud nõuavad API-võtit X-Api-Key päise kaudu. Vaadake Autentimine üksikasjade saamiseks.

Lõpp-punktid

Meetod	Tee	Kirjeldus	Leht
POST	/upload/new	Laadige fail IPFS-i üles	Failid
GET	/upload/list	Loetlege üleslaaditud failid	Failid
GET	/file/:cid	Hankige faili metaandmed CID järgi	Failid
PUT	/files/:cid/name	Nimetage fail ümber	Failid
PUT	/files/:cid/move	Liigutage fail kausta	Kaustad
POST	/pin	Kinnitage olemasolev CID IPFS-võrgust (toetab swarm-connect vihjeid)	Kinnitamine
GET	/pin/:cid	Kontrollige kinnitamise olekut	Kinnitamine
POST	/folders	Looge kaust	Kaustad
GET	/folders	Loetlege kaustad	Kaustad
PUT	/folders/:folderId	Uuendage kausta	Kaustad
DELETE	/folders/:folderId	Kustutage kaust	Kaustad
POST	/folders/:folderId/snapshot	Tehke kaustast hetktõmmis kataloogi CID-ina	Kaustad
PUT	/folders/:folderId/cors	Määrake kausta-põhine CORS-seadistus	Kaustad
GET	/folders/:folderId/cors	Hankige kausta-põhine CORS-seadistus	Kaustad
DELETE	/folders/:folderId/cors	Eemaldage kausta-põhine CORS-seadistus	Kaustad
GET	/user/profile	Hankige kasutajaprofiil	Profiil
POST	/apikeys	Looge API-võti	API-võtmed
GET	/apikeys	Loetlege API-võtmed	API-võtmed
DELETE	/apikeys/:key	Kustutage API-võti	API-võtmed
GET	/analytics	Kasutusanalüütika	Analüütika
PUT	/gateway-settings	Uuendage gateway seadeid	Gatewayd
POST	/gateway-tokens	Looge gateway token	Gatewayd
GET	/gateway-tokens	Loetlege gateway tokenid	Gatewayd
DELETE	/gateway-tokens/:prefix	Kustutage gateway token	Gatewayd
POST	/upload/signed-url	Genereerige allkirjastatud üleslaadimistoken	Allkirjastatud tokenid
GET	/signed-tokens	Loetlege allkirjastatud tokenid	Allkirjastatud tokenid
DELETE	/signed-tokens/:tokenId	Tühistage allkirjastatud token	Allkirjastatud tokenid
GET	/image/:cid	Optimeerige pilt lennult	Pildi optimeerimine

CIDv1 vaikimisi

Üleslaadimised ja kinnitused tagastavad kaasaegse CIDv1 (bafk… väikese üheplokilise sisu jaoks, bafy… suuremate failide ja kataloogide jaoks) vastavalt IPIP-0499 unixfs-v1-2025 profiilile. Varasemate üleslaadimiste vanapärased Qm… CID-d jäävad kõikjal täielikult lahendatavaks — Qm… on kehtiv sisend igale lõpp-punktile, mis aktsepteerib CID-i.

S3-ühilduv API

Kasutage mis tahes AWS SDK-d failide üleslaadimiseks ja haldamiseks IPFS Ninja's. Suunake oma S3 klient aadressile https://s3.ipfs.ninja, kasutades API-võtit volitustena.

https://s3.ipfs.ninja

S3 operatsioon	Kirjeldus
PutObject	Laadige fail IPFS-i üles
GetObject	Laadige fail alla
HeadObject	Hankige faili metaandmed
DeleteObject	Eemaldage kinnitus ja kustutage fail
ListObjectsV2	Loetlege failid prefiksi filtreerimisega
CreateMultipartUpload	Alustage mitmeosalist üleslaadimist (kuni 5 GB)
UploadPart	Laadige üles osa
CompleteMultipartUpload	Lõpetage mitmeosaline üleslaadimine
ListBuckets	Loetlege oma gatewayd
CreateBucket	Looge gateway (bucket'ite nimed on globaalselt unikaalsed — tagastab BucketAlreadyExists, kui nimi on juba võetud)
DeleteBucket	Kustutage gateway
PutBucketCors	Seadistage kausta-põhised CORS-reeglid (vajalik brauseri SDK kasutamiseks)
GetBucketCors	Lugege bucket'i praegust CORS-seadistust
DeleteBucketCors	Eemaldage kõik CORS-reeglid bucket'ilt

Vaadake S3 ühilduvus täieliku dokumentatsiooni, koodinäidete ja migratsioonijuhendite jaoks.