API klíče, rozsahy přístupu a testovací režim
Stručná odpověď
V Pro a Team vytvoříte API klíče v Přehled > Doména a API. Každý klíč má přístup (Pouze čtení, Čtení a zápis nebo Plný přístup) a režim: ostré klíče (pf_live_) fungují naostro, testovací klíče (pf_test_) nikdy nikomu nepošlou e-mail a jejich přenosy vyprší po 24 hodinách.
API Pandafile umožňuje vašim aplikacím, skriptům a serverům posílat soubory, sbírat nahrané soubory a žádat o podpisy. Je součástí Pro a Team a řídí se stejnými limity jako web. Všechno začíná API klíčem.
Vytvoření klíče
- Přihlaste se a otevřete Přehled > Doména a API.
- V sekci API klíče klíč pojmenujte, například Nahrávání z webu.
- Zvolte režim klíče, Ostrý nebo Testovací, a přístup klíče: Plný přístup, Čtení a zápis, nebo Pouze čtení.
- Klikněte na Vytvořit klíč a hned ho zkopírujte. Z bezpečnostních důvodů ho zobrazíme jen jednou.
- Posílejte ho s každým požadavkem v hlavičce Authorization: Bearer, za kterou následuje klíč.
Aktivních klíčů můžete mít nejvýš 10. Ostré klíče začínají na pf_live_, testovací na pf_test_. Průvodce pro vývojáře najdete na pandafile.co/developers a referenci API na pandafile.co/developers/api.
Rozsahy: co klíč smí
- Pouze čtení: jen požadavky GET. Klíč může věci vyhledat, ale nic nezmění.
- Čtení a zápis: vše z Pouze čtení a navíc vytváření, změny a mazání přenosů, žádostí o soubory, žádostí o podpis a odběrů webhooků.
- Plný přístup: všechno, včetně nastavení účtu, jako je branding a pozvánky do týmu.
Testovací režim
- Přenosy vytvořené klíčem pf_test_ jsou testovací data. Nikomu se nikdy nepošle e-mail, ani příjemcům, které přidáte.
- Testovací přenosy vždy vyprší 24 hodin po vytvoření a nelze je prodloužit.
- Nezapočítávají se do žádného limitu, úložiště ani využití a nezobrazují se v běžných seznamech přenosů.
- Události webhooků, které se jich týkají, mají livemode nastavené na false a nikdy nechodí do Slacku, Microsoft Teams ani Discordu.
- Několik akcí funguje jen s ostrým klíčem. S testovacím klíčem pak API odpoví chybou test_mode_unsupported.
Chraňte své klíče
- Kdokoli s klíčem může posílat soubory z vašeho účtu. Klíče mějte na svém serveru, nikdy ve veřejném kódu webu nebo aplikace.
- Pokud mohl klíč uniknout, zrušte ho v Přehled > Doména a API. Aplikace, které ho používají, okamžitě přestanou fungovat a zastaví se i odběry webhooků vytvořené tímto klíčem, například přes Zapier nebo Make.
- Každý klíč má vlastní limit počtu požadavků. Každá odpověď ukazuje, jak na tom jste, v hlavičkách RateLimit.
- V týmu jsou API klíče osobní: každý člen si vytváří vlastní.