Jak utworzyć lub klonować 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 zdefiniować zakres. 

Zarówno klucz prywatny API, jak i zakresy pomagają chronić Ciebie i Twojego dane klienta, ograniczając dostęp osób trzecich.

O prywatnym kluczu API i lunetach

Gdy wykonujesz połączenie API, pozwala ono jednemu oprogramowaniu połączyć się z innym. Połączenie to umożliwia oprogramowaniu żądanie, edytowanie lub dodawanie informacji do drugiego oprogramowania.  

Prywatny klucz API upewnia się, że to żądanie ma odpowiednie uprawnienia (tj. pochodzi od autoryzowanego użytkownika, konta lub programu). Pomyśl o nim jak o kluczu do domu: wpuszcza ciebie i twoją rodzinę, ale chroni przed wszystkimi innymi.

Włączenie zakresu dla prywatnego klucza API dodaje kolejną warstwę autoryzacji, ograniczając, do jakiego konkretnego elementu strona trzecia może uzyskać dostęp. Zakresy są podobne do kluczy hotelowych, dając ci dostęp tylko do określonych obszarów (takich jak twój pokój lub siłownia), a nie do całego budynku. 

Rodzaje zakresów

Kiedy tworzysz prywatny klucz API, musisz wybrać jego zakres. Innymi słowy, musisz zdecydować, czy chcesz, aby strona trzecia to zrobiła:

• Nie masz dostępu do API punktu końcowego.
• Wyświetl wszystkie dane dla API punktu końcowego, ale bez możliwości wprowadzania zmian (zwanych również "tylko do odczytu"). 
• Twórz, usuwaj i dokonuj innych zmian we wszystkim, co jest powiązane z tym punktem końcowym (zwany także "pełnym dostępem" lub "dostępem do zapisu").

Załóżmy na przykład, że chcesz dodać subskrybenta do listy Klaviyo z oprogramowania innej firmy. W takim przypadku musisz mieć pełny dostęp (do zapisu) do API punktu końcowego dla listy, profilu i profilu subskrypcji zbiorczej. Strona trzecia nie potrzebuje jednak dostępu do żadnego innego punktu końcowego. 

Możesz zapoznać się z APIKlaviyo i zobaczyć dostępne zakresy dla każdego punktu końcowego na portalu deweloperskim. 

Kilka słów na początek

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

• Po utworzeniu prywatnego klucza API nie możesz tego zrobić:
  • Wyświetl ponownie prywatny klucz API. 
    • Wskazówka: bezpiecznie zapisz prywatny klucz API i zanotuj, do czego chcesz go używać, np. w menedżerze haseł. 
  • Dodaj lub edytuj jego zakres. 
    • Jeśli chcesz zmienić zakres, jedyną opcją jest usunięcie oryginalnego prywatnego klucza API, a następnie utworzenie nowego z odpowiednim zakresem. 
• Prywatny klucz API ma domyślnie pełny dostęp.

Jeśli nie masz pewności, którego API punktu końcowego, zakresu lub uprawnień potrzebujesz, skontaktuj się z deweloperem lub docieraj do Klaviyo partner o pomoc. 

Utwórz prywatny klucz API 

1. Kliknij nazwę swojej organizacji w lewym dolnym rogu.
2. Przejdź do Ustawień.
3. Kliknij klucz API.
   
4. Kliknij przycisk Utwórz prywatny klucz API.
5. Nazwij klucz API.
6. Wybierz zakres, któremu chcesz nadać klucz API:
   • Tylko do odczytu
   • Pełny
   • Niestandardowy
     
7. Wybierz opcję Utwórz.

Teraz, gdy udostępnisz prywatny klucz API, strona trzecia będzie miała dostęp tylko do informacji zdefiniowanych w zakresie. 

Korzystanie z zapytań 

Zapytania są używane w zaawansowanych scenariuszach. Jeśli nie znasz jeszcze zapytań lub nie wiesz, jak z nich korzystać, zalecamy współpracę z programistą. 

Uwzględnij

Zauważ, że jeśli spróbujesz użyć zapytania include, będziesz musiał zmienić format z podanego powyżej.

Na przykład profil punkt końcowy to /API/profil.

Jeśli jednak dodasz parametr include zapytania(/API/profil?include=lista), Będziesz także potrzebował dostępu lista :read lub lista:full, w zależności od typu wywołania API.

Zakresy

Korzystając z parametru scopes, możesz utworzyć parametr URL do automatycznego wypełniania zakresu dostępu, którego potrzebujesz dla swojego prywatnego klucza API. 

W zapytaniu o zakresy dołącz listę rozdzielaną przecinkami zakresów, które chcesz wstępnie wybrać. 

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

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

klonować prywatny klucz API

Dzięki kluczowi prywatnemu API, klonowanie umożliwia utworzenie nowego klucza, który ma takie same zakresy i uprawnienia jak klucz oryginalny.

Zauważ, że:

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

Aby klonować prywatny klucz API: 

1. Przejdź do zakładki klucz API . 
2. Kliknij menu z 3 kropkami obok klawisza, który chcesz sklonować. 
3. Wybierz klonować > klonować. 
   
4. Skopiuj lub pobierz nowy prywatny klucz API i umieść go w bezpiecznym miejscu. 
5. Pamiętaj, aby usunąć stary klucz, jeśli nie jest już potrzebny. 

Dodatkowe źródła

• Zobacz nasz artykuł na temat Pierwsze kroki z Klaviyo API.
• przejdź na stronę płatności przejdź do kasy więcej dokumentów deweloperskich.
• Dowiedz się więcej o bezpieczeństwie swojego konta.