Tworzenie kluczy API i zarządzanie nimi
Tworzenie klucza do publicznego API, wybór jego zakresów i okresu ważności, ograniczenie do adresów IP i unieważnienie.
Klucz API pozwala Twoim narzędziom wywoływać publiczne API Upsellr w imieniu Twojej organizacji. Dostęp do API jest zarezerwowany dla planu Enterprise.
Gdzie znaleźć klucze
Otwórz menu konta, a następnie Manage i API & webhooks. W planie innym niż Enterprise sekcja wyświetla „Included in the Enterprise plan” i przycisk zmiany planu.
Tworzenie klucza
- Kliknij Create API Key.
- Nadaj mu Name, która mówi, do czego służy, na przykład nazwę narzędzia, które go używa.
- Wybierz Scope preset:
- Read only: odczyt kanałów, produktów, źródeł, workflow, członków i organizacji.
- Read & Write: wszystko z wyjątkiem uruchamiania workflow.
- Full access: wszystkie zakresy, łącznie z uruchamianiem workflow.
- Custom: zaznacz pojedynczo potrzebne zakresy.
- Wybierz Expiration: 7 dni, 30 dni, 90 dni, 1 rok, 3 lata, No expiration lub niestandardowy okres od 1 do 1 095 dni.
- W razie potrzeby wypełnij Allowed IPs i Allowed User-Agents, oddzielając wartości przecinkami.
- Kliknij Create Key.
Klucz jest wyświetlany tylko raz. Skopiuj go i przechowuj w bezpiecznym miejscu, zanim zamkniesz okno.
Dostępne zakresy
| Zasób | Zakresy |
|---|---|
| Kanały | Tworzenie, odczyt, zmiana, usuwanie |
| Produkty | Tworzenie, odczyt, zmiana, usuwanie |
| Źródła | Odczyt, przesyłanie plików źródłowych |
| Workflow | Odczyt, uruchamianie |
| Organizacja | Odczyt organizacji, odczyt członków |
Unieważnianie klucza
Na liście kliknij Revoke obok klucza. Każda integracja, która go używa, natychmiast przestaje działać. To działanie jest nieodwracalne.
Dobrze wiedzieć
- Tylko właściciele i administratorzy tworzą i unieważniają klucze. Członkowie widzą je tylko do odczytu.
- Lista pokazuje dla każdego klucza jego zakresy, datę wygaśnięcia i Last used: klucz nigdy nieużywany to często klucz do unieważnienia.
- Uruchomienie workflow może objąć wiele produktów i kredytów. Nadawaj zakres uruchamiania tylko integracjom, które go potrzebują.
- Twórz jeden klucz na integrację, tylko z niezbędnymi zakresami.
- Zgubionego klucza nie można wyświetlić ponownie: unieważnij go i utwórz nowy.