FAQ

Často kladené otázky o IPFS Ninja.

Obecné

Co je IPFS Ninja?

IPFS Ninja je spravovaná služba pro připínání na IPFS. Nahráváte jakýkoli soubor přes jednoduché REST API, nebo připínáte existující CID ze sítě IPFS. Každý soubor získá trvalý identifikátor obsahu (CID) a je přístupný přes naši gateway na ipfs.ninja/ipfs/<CID>.

Jaké typy souborů jsou podporovány?

Všechny typy souborů jsou podporovány. JSON objekty a pole mohou být odeslány přímo. Všechny ostatní soubory (obrázky, PDF, HTML, video, audio, binární soubory) jsou odesílány jako obsah kódovaný v base64.

Existuje limit velikosti souboru?

Jednotlivé nahrávání jsou omezeny úložným limitem vašeho plánu. Neexistuje žádný limit na velikost jednotlivého souboru mimo vaše dostupné úložiště.

Mohu připnout obsah, který již existuje na IPFS?

Ano. Použijte POST /pin s jakýmkoli platným CID. Náš cluster načte obsah ze sítě IPFS a připne ho k vašemu účtu. Podrobnosti naleznete v dokumentaci Pinning API.

Jak dlouho trvá připnutí?

Závisí to na velikosti souboru a počtu IPFS uzlů, které mají obsah. Malé, dobře distribuované soubory se připnou za sekundy. Velký nebo zřídka připínaný obsah může trvat několik minut. Endpoint pro připnutí vrátí okamžitě stav pinning — dotazujte se na GET /pin/:cid pro kontrolu průběhu.

Co se stane, když CID nelze najít?

Stav se změní na failed. To znamená, že CID je buď neplatný, nebo obsah již není dostupný na žádném dosažitelném IPFS uzlu.

Jsou data nahraná na IPFS veřejná?

Ano. Veškerý obsah připnutý na IPFS je veřejně přístupný přes jeho CID prostřednictvím jakékoli IPFS gateway. Pokud potřebujete soukromý přístup, použijte dedikovanou gateway s režimem vyžadujícím token — tím omezíte přístup přes vaši gateway, přestože obsah zůstane dostupný na širší síti IPFS.

Zůstanou mé soubory na IPFS, pokud zruším účet?

Při zrušení odpneme vaše soubory z našich uzlů. Pokud jiné IPFS uzly mají váš obsah v mezipaměti, může zůstat přístupný. Bez aktivního připnutí však budou soubory postupně odstraněny sběrem odpadu v celé síti.

Autentizace & API

Jak autentizuji API požadavky?

Předejte svůj API klíč přes hlavičku X-Api-Key. Klíče generujte ze stránky API klíče ve vašem řídicím panelu.

Existují limity rychlosti API?

Ne. IPFS Ninja neukládá žádné limity rychlosti na API požadavky. Na jakémkoli plánu můžete provádět tolik požadavků, kolik potřebujete.

Mají API klíče expiraci?

Ne. API klíče jsou platné, dokud je nesmažete. Můžete vytvořit více klíčů a jednotlivě je odvolat.

Jaký je rozdíl mezi API klíči a tokeny gateway?

API klíče (bws_) mají plný přístup — nahrávání, mazání, seznam souborů. Tokeny gateway (gwt_) jsou jen pro čtení a mohou přistupovat k souborům pouze přes vaši dedikovanou gateway. Tokeny gateway je bezpečné vkládat do frontendových aplikací.

Dedikované gateway

Co je dedikovaná gateway?

Soukromá IPFS gateway na vaší vlastní subdoméně (např. abc123.gw.ipfs.ninja), která obsluhuje pouze soubory připnuté k vašemu účtu. Na rozdíl od veřejné gateway nebude překládat CID od jiných uživatelů.

Které plány zahrnují dedikovanou gateway?

Dedikované gateway jsou dostupné v plánu Nirvana (29 $/měs.), který zahrnuje 50 GB/měsíc šířky pásma gateway.

Mohu omezit, kdo přistupuje k mé gateway?

Ano. Můžete povolit režim vyžadující token (vyžaduje token gwt_ při každém požadavku) a/nebo nastavit whitelist IP adres (až 100 adres).

Mohu omezit mou gateway podle původu/domény?

Ano. Nakonfigurujte allowedOrigins ve vašem nastavení gateway se seznamem HTTPS původů. Pouze požadavky z prohlížečů z těchto původů budou povoleny. Požadavky mimo prohlížeč (bez hlavičky Origin) procházejí bez omezení. Prázdný seznam povoluje všechny původy.

Co jsou podepsané tokeny pro nahrávání?

Podepsané tokeny pro nahrávání jsou časově omezené přihlašovací údaje pro nahrávání na straně klienta. Generujete je na svém serveru pomocí POST /upload/signed-url a předáváte je prohlížečům nebo mobilním aplikacím. Klient se autentizuje pomocí Authorization: Signed <token> místo odhalení vašeho API klíče. Každý token sleduje využití a automaticky expiruje. Podrobnosti naleznete v dokumentaci Podepsaných tokenů.

Mohu optimalizovat obrázky servírované z IPFS?

Ano. Použijte GET /image/:cid s parametry dotazu jako w, h, format a quality pro změnu velikosti, převod a kompresi obrázků za běhu. Odpovědi jsou ukládány do mezipaměti na základě CID adresovaného obsahem. Funguje to na všech plánech. Viz Optimalizace obrázků.

Mohu přidat metadata k souborům?

Ano. Zahrňte objekt metadata s až 10 páry klíč-hodnota při nahrávání přes POST /upload/new nebo připínání přes POST /pin. Metadata jsou vrácena v seznamech souborů a endpointu detailu souboru. Viz dokumentace Soubory a Připínání.

Fakturace & plány

Existuje bezplatný plán?

Ano. Plán Dharma je zdarma navždy — 1 GB úložiště, neomezené API požadavky, bez nutnosti kreditní karty.

Jsou poplatky za šířku pásma?

Žádné poplatky za šířku pásma na API požadavcích pro jakýkoli plán. Šířka pásma dedikované gateway (plán Nirvana) zahrnuje 50 GB/měsíc. Po dosažení limitu jsou požadavky na gateway blokovány do dalšího měsíce.

Obnovuje se úložiště?

Úložiště se neobnovuje. Váš plán zahrnuje celkový úložný limit (1 GB / 10 GB / 100 GB). Pro uvolnění místa smažte soubory, které již nepotřebujete. Upgrade plánu zvýší váš celkový limit.

Mohu kdykoli zrušit?

Ano. Zrušte předplatné přes fakturační portál — bez závazku. Váš účet se vrátí na bezplatnou úroveň a existující připnuté soubory zůstanou přístupné.

Co se stane s mými soubory, pokud downgraduju?

Vaše soubory zůstanou připnuté na IPFS, ale nemůžete nahrávat další, pokud vaše aktuální využití přesahuje úložný limit nového plánu. Smažte soubory, abyste se vrátili pod limit.

Bezpečnost

Jsou moje data šifrována?

Všechna data jsou šifrována při přenosu přes TLS/HTTPS. Autentizace používá JWT tokeny (Cognito) a bezpečně uložené API klíče. Obsah souborů na IPFS není šifrován v klidovém stavu — IPFS je ze své podstaty veřejná síť.

Je bezpečné používat API klíče v mém serverovém kódu?

Ano. API klíče jsou navrženy pro použití na straně serveru. Nikdy je nevystavujte v kódu na straně klienta. Pro přístup k souborům na straně klienta používejte tokeny gateway (gwt_), které jsou jen pro čtení.

Podpora

Jak získám pomoc?

Napište na info@ipfs.ninja nebo si prohlédněte dokumentaci Referenční příručka API.

Existuje SLA?

Usilujeme o vysokou dostupnost, ale v současné době nenabízíme formální SLA. Služba je poskytována na základě „tak, jak je".