Klucze API, zakresy dostępu i tryb testowy
Krótka odpowiedź
W Pro i Team tworzysz klucze API w Panelu > Domena i API. Każdy klucz ma zakres dostępu (Tylko odczyt, Odczyt i zapis lub Pełny dostęp) i tryb: klucze produkcyjne (pf_live_) działają naprawdę, klucze testowe (pf_test_) nigdy do nikogo nie wysyłają e-maili, a ich transfery wygasają po 24 godzinach.
API Pandafile pozwala twoim aplikacjom, skryptom i serwerom wysyłać pliki, zbierać przesyłki i prosić o podpisy. Jest zawarte w Pro i Team i działa według tych samych limitów co strona. Wszystko zaczyna się od klucza API.
Utwórz klucz
- Zaloguj się i otwórz Panel > Domena i API.
- W sekcji Klucze API nadaj kluczowi nazwę, np. Przesyłanie ze strony.
- Wybierz tryb klucza, Produkcyjny lub Testowy, oraz dostęp klucza: Pełny dostęp, Odczyt i zapis lub Tylko odczyt.
- Kliknij Utwórz klucz i od razu go skopiuj. Ze względów bezpieczeństwa pokazujemy go tylko raz.
- Wysyłaj go w każdym żądaniu w nagłówku Authorization: Bearer, a po nim klucz.
Możesz mieć do 10 aktywnych kluczy. Klucze produkcyjne zaczynają się od pf_live_, a testowe od pf_test_. Przewodnik dla programistów znajdziesz na pandafile.co/developers, a dokumentację API na pandafile.co/developers/api.
Zakresy: co może klucz
- Tylko odczyt: wyłącznie żądania GET. Klucz może sprawdzać dane, ale niczego nie zmienia.
- Odczyt i zapis: wszystko z Tylko odczyt, a do tego tworzenie, zmienianie i usuwanie transferów, próśb o pliki, próśb o podpis i subskrypcji webhooków.
- Pełny dostęp: wszystko, w tym ustawienia konta, takie jak branding i zaproszenia do zespołu.
Tryb testowy
- Transfery utworzone kluczem pf_test_ to dane testowe. Nikt nigdy nie dostaje e-maila, nawet dodani odbiorcy.
- Transfery testowe zawsze wygasają 24 godziny po utworzeniu i nie można ich przedłużyć.
- Nie wliczają się do żadnego limitu, miejsca ani zużycia i nie pojawiają się na zwykłych listach transferów.
- Zdarzenia webhooków na ich temat mają livemode ustawione na false i nigdy nie trafiają do Slacka, Microsoft Teams ani Discorda.
- Kilka operacji działa tylko z kluczem produkcyjnym. Z kluczem testowym API odpowiada wtedy błędem test_mode_unsupported.
Chroń swoje klucze
- Każdy, kto ma klucz, może wysyłać pliki z twojego konta. Trzymaj klucze na serwerze, nigdy w publicznym kodzie strony czy aplikacji.
- Unieważnij klucz w Panelu > Domena i API, jeśli mógł wyciec. Aplikacje, które go używają, od razu przestają działać, a subskrypcje webhooków utworzone tym kluczem, np. przez Zapier lub Make, także się zatrzymują.
- Każdy klucz ma własny limit żądań. Każda odpowiedź pokazuje, ile ci zostało, w nagłówkach RateLimit.
- W zespole klucze API są osobiste: każdy członek tworzy własne.