API-viite

Kaikki päätepisteet, parametrit, pyyntö-/vastausmuodot ja virhekoodit.

Perus-URL

https://api.ipfs.ninja

Kaikki pyynnöt vaativat API-avaimen X-Api-Key-otsakkeen kautta. Katso Todennus lisätiedoille.

Päätepisteet

Metodi	Polku	Kuvaus	Sivu
POST	/upload/new	Lataa tiedosto IPFS:ään	Tiedostot
GET	/upload/list	Listaa ladatut tiedostot	Tiedostot
GET	/file/:cid	Hae tiedoston metatiedot CID:llä	Tiedostot
PUT	/files/:cid/name	Nimeä tiedosto uudelleen	Tiedostot
PUT	/files/:cid/move	Siirrä tiedosto kansioon	Kansiot
POST	/pin	Kiinnitä olemassa oleva CID IPFS-verkosta (tukee swarm-connect-vihjeitä)	Kiinnitys
GET	/pin/:cid	Tarkista kiinnityksen tila	Kiinnitys
POST	/folders	Luo kansio	Kansiot
GET	/folders	Listaa kansiot	Kansiot
PUT	/folders/:folderId	Päivitä kansio	Kansiot
DELETE	/folders/:folderId	Poista kansio	Kansiot
POST	/folders/:folderId/snapshot	Ota kansiosta tilannevedos hakemisto-CID:ksi	Kansiot
PUT	/folders/:folderId/cors	Aseta bucket-kohtainen CORS-määritys	Kansiot
GET	/folders/:folderId/cors	Hae bucket-kohtainen CORS-määritys	Kansiot
DELETE	/folders/:folderId/cors	Poista bucket-kohtainen CORS-määritys	Kansiot
GET	/user/profile	Hae käyttäjäprofiili	Profiili
POST	/apikeys	Luo API-avain	API-avaimet
GET	/apikeys	Listaa API-avaimet	API-avaimet
DELETE	/apikeys/:key	Poista API-avain	API-avaimet
GET	/analytics	Käyttöanalytiikka	Analytiikka
PUT	/gateway-settings	Päivitä gateway-asetukset	Gatewayt
POST	/gateway-tokens	Luo gateway-token	Gatewayt
GET	/gateway-tokens	Listaa gateway-tokenit	Gatewayt
DELETE	/gateway-tokens/:prefix	Poista gateway-token	Gatewayt
POST	/upload/signed-url	Generoi allekirjoitettu lataustoken	Allekirjoitetut tokenit
GET	/signed-tokens	Listaa allekirjoitetut tokenit	Allekirjoitetut tokenit
DELETE	/signed-tokens/:tokenId	Peruuta allekirjoitettu token	Allekirjoitetut tokenit
GET	/image/:cid	Optimoi kuva lennossa	Kuvan optimointi

CIDv1 oletuksena

Lataukset ja kiinnitykset palauttavat nykyaikaisen CIDv1-tunnisteen (bafk… pienelle yksilohkoiselle sisällölle, bafy… suuremmille tiedostoille ja hakemistoille) IPIP-0499 unixfs-v1-2025 -profiilin mukaisesti. Aiempien latausten vanhat Qm…-CID:t pysyvät täysin ratkaistavissa kaikkialla — Qm… on kelvollinen syöte mille tahansa CID:n hyväksyvälle päätepisteelle.

S3-yhteensopiva API

Käytä mitä tahansa AWS SDK:ta tiedostojen lataamiseen ja hallintaan IPFS Ninjassa. Osoita S3-asiakasohjelmasi osoitteeseen https://s3.ipfs.ninja API-avaimellasi tunnistetietoina.

https://s3.ipfs.ninja

S3-operaatio	Kuvaus
PutObject	Lataa tiedosto IPFS:ään
GetObject	Lataa tiedosto
HeadObject	Hae tiedoston metatiedot
DeleteObject	Irrota kiinnitys ja poista tiedosto
ListObjectsV2	Listaa tiedostot prefiksisuodatuksella
CreateMultipartUpload	Aloita monivaiheinen lataus (enintään 5 Gt)
UploadPart	Lataa osa
CompleteMultipartUpload	Viimeistele monivaiheinen lataus
ListBuckets	Listaa gatewaysi
CreateBucket	Luo gateway (bucket-nimet ovat maailmanlaajuisesti yksilöllisiä — palauttaa BucketAlreadyExists, jos nimi on varattu)
DeleteBucket	Poista gateway
PutBucketCors	Määritä bucket-kohtaiset CORS-säännöt (vaaditaan selain-SDK:n käyttöön)
GetBucketCors	Lue bucketin nykyinen CORS-määritys
DeleteBucketCors	Poista kaikki CORS-säännöt bucketista

Katso S3-yhteensopivuus täydellinen dokumentaatio, koodiesimerkit ja migraatio-oppaat.