Jak utworzyć lub sklonować prywatny klucz API

Czego się dowiesz?

Dowiedz się, jak utworzyć prywatny klucz API, który jest unikalnym identyfikatorem używanym do wywołań API, a także jak zdefiniować zakres.

Zarówno prywatne klucze API, jak i zakresy pomagają chronić Twoje dane oraz dane Twoich klientów, ograniczając to, do czego mogą uzyskać dostęp strony trzecie.

Informacje o prywatnych kluczach API i zakresach

Gdy wykonujesz wywołanie API, umożliwia ono jednemu oprogramowaniu połączenie się z innym. To połączenie pozwala oprogramowaniu żądać, edytować lub dodawać informacje w drugim. 

Prywatny klucz API zapewnia, że to żądanie ma odpowiednie uprawnienia (tzn. że pochodzi od autoryzowanego użytkownika, konta lub programu). Potraktuj to jak klucz do domu: wpuszcza Ciebie i Twoją rodzinę, ale nie wpuszcza nikogo innego.

Uwzględnienie zakresu dla prywatnego klucza API dodaje kolejną warstwę autoryzacji, ograniczając to, do jakich konkretnych elementów może uzyskać dostęp strona trzecia. Zakresy są podobne do klucza hotelowego: dają dostęp tylko do określonych obszarów (np. pokoju lub siłowni), a nie do całego budynku.

Typy zakresów

Podczas tworzenia prywatnego klucza API musisz wybrać jego zakres. Innymi słowy, musisz zdecydować, czy chcesz, aby podmiot zewnętrzny:

• Nie mieć dostępu do punktu końcowego API.
• Wyświetlał wszystkie dane dla punktu końcowego API, ale nie mógł wprowadzać zmian (nazywane także „tylko do odczytu”).
• Twórz, usuwaj i wprowadzaj inne zmiany we wszystkim, co jest powiązane z tym punktem końcowym (nazywane też „pełnym dostępem” lub „dostępem do zapisu”).

Na przykład: załóżmy, że chcesz dodawać subskrybentów do listy Klaviyo z oprogramowania firmy trzeciej. W takim przypadku musisz mieć pełny (zapisu) dostęp do punktów końcowych API dla list, profili oraz zbiorczego subskrybowania profili. Jednak firma trzecia nie potrzebuje dostępu do żadnego innego punktu końcowego.

Możesz dowiedzieć się więcej o API Klaviyo i sprawdzić dostępne zakresy dla każdego punktu końcowego w portalu deweloperskim.

Kilka słów na początek

Zwróć uwagę na następujące kwestie:

• Po utworzeniu prywatnego klucza API nie możesz:
  • Wyświetl ponownie prywatny klucz API.
    • Wskazówka: bezpiecznie przechowuj prywatne klucze API i zanotuj, do czego chcesz ich używać, na przykład w menedżerze haseł.
  • Dodaj lub edytuj jej zakresy.
    • Jeśli trzeba zmienić zakresy, jedyną opcją jest usunięcie oryginalnego prywatnego klucza API, a następnie utworzenie nowego z odpowiednim zakresem.
• Prywatne klucze API mają domyślnie pełny dostęp.

Jeśli nie masz pewności, których punktów końcowych API, zakresów lub uprawnień potrzebujesz, skontaktuj się z deweloperem lub zwróć się o pomoc do partnera Klaviyo.

Utwórz prywatny klucz API

1. W lewym dolnym rogu kliknij nazwę swojej organizacji.
2. Przejdź do Ustawienia.
3. Click klucz API.
   

4. Kliknij Utwórz prywatny klucz API.
5. Nadaj nazwę kluczowi API.
6. Wybierz zakres uprawnień, który chcesz nadać kluczowi API:
   • Tylko do odczytu
   • Pełny
   • Niestandardowy

7. Wybierz opcję Utwórz.

Teraz, gdy udostępnisz prywatny klucz API, podmiot zewnętrzny będzie miał dostęp tylko do informacji, które zdefiniowano w zakresie.

Korzystanie z zapytań

Zapytania są używane w zaawansowanych scenariuszach. Jeżeli nie znasz jeszcze zapytań ani sposobu ich użycia, zalecamy współpracę z programistą.

Uwzględnij

Pamiętaj, że jeśli spróbujesz użyć zapytania include, musisz zmienić format względem tego, co podano powyżej.

Na przykład punkt końcowy profilów to /api/profiles.

Jeśli jednak dodasz parametr zapytania include (/api/profiles?include=list), będziesz też potrzebować uprawnienia list:read lub list:full access, w zależności od rodzaju wykonywanego wywołania API.

Zakresy

Za pomocą parametru scopes możesz utworzyć parametr URL, aby automatycznie uzupełnić, jakiego dostępu w zakresie potrzebujesz dla prywatnego klucza API.

W zapytaniu scopes uwzględnij listę zakresów oddzielonych przecinkami, które chcesz wstępnie wybrać.

Przykładowy adres URL:
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write

Przejdź do naszego portalu deweloperskiego, aby zobaczyć zakresy, których można użyć w tym zapytaniu.

Sklonuj prywatny klucz API

Dzięki prywatnym kluczom API klonowanie pozwala utworzyć nowy klucz, który ma te same zakresy i uprawnienia co oryginalny klucz.

Pamiętaj:

• Klonowanie nie generuje tego samego klucza co pierwotny prywatny klucz API.
• Nie można zmienić nazwy sklonowanego klucza API; ma on taką samą nazwę jak klucz oryginalny.

Aby sklonować prywatny klucz API:

1. Przejdź do karty Klucze API .
2. Kliknij menu z 3 kropkami obok klucza, który chcesz sklonować.
3. Wybierz Klonuj > Klonuj.
   

4. Skopiuj lub pobierz nowy prywatny klucz API i przechowuj go w bezpiecznym miejscu.
5. Pamiętaj o usunięciu starego klucza, jeśli nie jest już potrzebny.

Dodatkowe źródła