DUK

Dažnai užduodami klausimai apie IPFS Ninja.

Bendra informacija

Kas yra IPFS Ninja?

IPFS Ninja yra valdoma IPFS prisegimo paslauga. Įkeliate bet kokį failą per paprastą REST API arba prisegate esamus CID iš IPFS tinklo. Kiekvienas failas gauna nuolatinį turinio identifikatorių (CID) ir yra pasiekiamas per mūsų gateway adresu ipfs.ninja/ipfs/<CID>.

Kokie failų tipai palaikomi?

Visi failų tipai palaikomi. JSON objektus ir masyvus galima siųsti tiesiogiai. Visi kiti failai (vaizdai, PDF, HTML, vaizdo įrašai, garso įrašai, dvejetainiai) siunčiami kaip base64 koduotas turinys.

Ar yra failo dydžio apribojimas?

Atskirus įkėlimus riboja jūsų plano saugyklos kvota. Atskiram failui nėra dydžio apribojimo, išskyrus jūsų turimą saugyklą.

Ar galiu prisegti turinį, kuris jau yra IPFS?

Taip. Naudokite POST /pin su bet kokiu galiojančiu CID. Mūsų klasteris gaus turinį iš IPFS tinklo ir prisegs jį prie jūsų paskyros. Žiūrėkite Pinning API dokumentaciją daugiau informacijos.

Kiek laiko užtrunka prisegimas?

Tai priklauso nuo failo dydžio ir to, kiek IPFS mazgų turi turinį. Maži, gerai paskirstyti failai prisegami per sekundes. Didelis ar retai prisegtas turinys gali užtrukti kelias minutes. Prisegimo galinis taškas grąžina iš karto su būsena pinning — apklauskite GET /pin/:cid norėdami patikrinti eigą.

Kas nutinka, jei CID nerandamas?

Būsena pasikeičia į failed. Tai reiškia, kad CID yra neteisingas arba turinys nebepasiekiamas jokiame pasiekiamame IPFS mazge.

Ar į IPFS įkelti duomenys yra vieši?

Taip. Visas IPFS prisegtas turinys yra viešai pasiekiamas per jo CID bet kuriame IPFS gateway. Jei reikia privačios prieigos, naudokite dedikuotą gateway su tokeno reikalavimo režimu — tai apriboja prieigą per jūsų gateway, nors turinys lieka pasiekiamas platesniame IPFS tinkle.

Ar mano failai liks IPFS, jei atšauksiu paskyrą?

Mes atsegame jūsų failus iš mūsų mazgų, kai atšaukiate. Jei kiti IPFS mazgai yra išsaugoję jūsų turinį podėlyje, jis gali likti pasiekiamas. Tačiau be aktyvaus prisegimo failai galiausiai bus pašalinti šiukšlių surinkimo metu visame tinkle.

Autentifikacija & API

Kaip autentifikuoti API užklausas?

Perduokite savo API raktą per X-Api-Key antraštę. Generuokite raktus iš API raktai puslapio savo valdymo skyde.

Ar yra API greičio apribojimai?

Ne. IPFS Ninja netaiko greičio apribojimų API užklausoms. Galite atlikti tiek užklausų, kiek reikia, bet kuriame plane.

Ar API raktai baigia galioti?

Ne. API raktai galioja, kol juos ištrinsite. Galite sukurti kelis raktus ir atšaukti juos atskirai.

Koks skirtumas tarp API raktų ir gateway tokenų?

API raktai (bws_) turi pilną prieigą — įkelti, ištrinti, pateikti failų sąrašą. Gateway tokenai (gwt_) yra tik skaitymui ir gali pasiekti failus tik per jūsų dedikuotą gateway. Gateway tokenus saugu naudoti frontend programose.

Dedikuoti gateway

Kas yra dedikuotas gateway?

Privatus IPFS gateway jūsų padomenyje (pvz., abc123.gw.ipfs.ninja), kuris aptarnauja tik prie jūsų paskyros prisegtus failus. Skirtingai nuo viešojo gateway, jis neišspręs kitų naudotojų CID.

Kurie planai apima dedikuotą gateway?

Dedikuoti gateway prieinami Nirvana plane (29 $/mėn.), kuris apima 50 GB/mėn. gateway pralaidumo.

Ar galiu apriboti, kas pasiekia mano gateway?

Taip. Galite įjungti tokeno reikalavimo režimą (reikalauja gwt_ tokeno kiekvienai užklausai) ir/arba nustatyti IP adresų baltąjį sąrašą (iki 100 adresų).

Ar galiu apriboti savo gateway pagal kilmę/domeną?

Taip. Konfigūruokite allowedOrigins savo gateway nustatymuose su HTTPS kilmių sąrašu. Leidžiamos tik naršyklės užklausos iš tų kilmių. Nenaršyklės užklausos (be Origin antraštės) praleidžiamos. Tuščias sąrašas leidžia visas kilmes.

Kas yra pasirašyti įkėlimo tokenai?

Pasirašyti įkėlimo tokenai yra riboto laiko kredencialai kliento pusės įkėlimams. Generuojate juos savo serveryje naudodami POST /upload/signed-url ir perduodate naršyklėms ar mobiliosioms programoms. Klientas autentifikuojasi Authorization: Signed <token> vietoj API rakto atskleidimo. Kiekvienas tokenas seka naudojimą ir baigia galioti automatiškai. Žiūrėkite pasirašytų tokenų dokumentaciją daugiau informacijos.

Ar galiu optimizuoti vaizdus, pateikiamus iš IPFS?

Taip. Naudokite GET /image/:cid su užklausos parametrais kaip w, h, format ir quality, kad pakeistumėte dydį, konvertuotumėte ir suspaustumėte vaizdus iš karto. Atsakymai talpinami podėlyje pagal turinio adresuotą CID. Tai veikia visuose planuose. Žiūrėkite Vaizdo optimizavimas.

Ar galiu pridėti metaduomenis prie failų?

Taip. Įtraukite metadata objektą su iki 10 rakto-reikšmės porų įkeliant per POST /upload/new arba prisegant per POST /pin. Metaduomenys grąžinami failų sąrašuose ir failo detalių galiniame taške. Žiūrėkite Failai ir Prisegimas dokumentaciją.

Atsiskaitymas & Planai

Ar yra nemokamas planas?

Taip. Dharma planas yra nemokamas amžinai — 1 GB saugyklos, neribotų API užklausų, kredito kortelė nereikalinga.

Ar yra pralaidumo mokesčiai?

Jokių pralaidumo mokesčių API užklausoms jokiame plane. Dedikuoto gateway pralaidumas (Nirvana planas) apima 50 GB/mėn. Pasiekus ribą, gateway užklausos blokuojamos iki kito mėnesio.

Ar saugykla atsinaujina?

Saugykla neatsinaujina. Jūsų planas apima bendrą saugyklos kvotą (1 GB / 10 GB / 100 GB). Norint atlaisvinti vietą, ištrinkite failus, kurių jums nebereikia. Plano atnaujinimas padidina jūsų bendrą kvotą.

Ar galiu atšaukti bet kada?

Taip. Atšaukite prenumeratą per atsiskaitymo portalą — jokio įsipareigojimo. Jūsų paskyra grįš į nemokamą lygį, o esami prisegti failai liks pasiekiami.

Kas nutinka su mano failais, jei sumažinu planą?

Jūsų failai lieka prisegti prie IPFS, bet negalite įkelti daugiau, jei jūsų dabartinis naudojimas viršija naujo plano saugyklos ribą. Ištrinkite failus, kad grįžtumėte žemiau ribos.

Saugumas

Ar mano duomenys šifruojami?

Visi duomenys šifruojami perdavimo metu per TLS/HTTPS. Autentifikacija naudoja JWT tokenus (Cognito) ir saugiai saugomus API raktus. Failo turinys IPFS nėra šifruojamas ramybės būsenoje — IPFS yra viešas tinklas pagal dizainą.

Ar saugu naudoti API raktus mano serverio kode?

Taip. API raktai skirti serverio pusės naudojimui. Niekada neatskleiskite jų kliento pusės kode. Kliento pusės failų prieigai naudokite gateway tokenus (gwt_), kurie yra tik skaitymui.

Pagalba

Kaip gauti pagalbą?

Siųskite el. laišką adresu info@ipfs.ninja arba žiūrėkite API nuorodą.

Ar yra SLA?

Siekiame aukšto prieinamumo, bet šiuo metu nesiūlome formalaus SLA. Paslauga teikiama „tokia, kokia yra" pagrindu.