Pierwsze kroki z interfejsami API Klaviyo
Czego się dowiesz?
Zdobądź podstawową wiedzę na temat wywołań API i tego, jak interfejsy API Klaviyo mogą przynieść korzyści Twojej firmie. Z tego przewodnika dowiesz się o interfejsach API REST, metodach HTTP i narzędziach deweloperskich, aby przygotować się do testowania interfejsów API Klaviyo. Pierwsze wywołania API możesz wykonać w zaledwie 10 minut — od początku do końca. Jeśli znasz już wywołania API i jesteś gotowy(-a) do przetestowania naszych interfejsów API, skorzystaj z naszego przewodnika, jak korzystać z naszych kolekcji Postman.
W tym przewodniku będziemy odsyłać do słowniczka, gdy pojawią się nowe terminy techniczne. Jeśli w dowolnym momencie przewodnika nie masz pewności co do znaczenia słowa, zajrzyj do słowniczka terminów technicznych.
Co to jest REST API?
REST API to zestaw skrótów oznaczających Representational State Transfer oraz Application Programming Interface. Te pojęcia można prościej rozumieć jako ustrukturyzowane żądania, które umożliwiają jednemu fragmentowi oprogramowania komunikowanie się z innym i przekazywanie między nimi informacji. Gdy wykonujesz wywołanie API Klaviyo, wysyłasz żądanie do serwera i otrzymujesz odpowiedź. Odpowiedź zawiera kod stanu oraz — gdy punkt końcowy zwraca dane — treść w formacie JSON (JavaScript Object Notation). Niektóre pomyślne żądania nie zwracają treści odpowiedzi.
Mówiąc prościej, REST API umożliwiają żądanie danych przechowywanych w magazynie danych w Klaviyo i otrzymanie tych danych z powrotem w formacie czytelnym dla Ciebie i komputerów.
Żądanie GET służące do pobrania danych obejmuje następujące kroki:
- Wyślij ustrukturyzowane żądanie danych przez internet do API. Żądania są wysyłane przez HTTP, podstawowy typ żądania sieciowego, na którym w dużej mierze opiera się internet.
- API otrzyma żądanie, przetworzy je i pobierze żądane informacje z baz danych Klaviyo.
- Następnie API odpowiada aplikacji klienckiej w ustrukturyzowanym formacie JSON.
- Otrzymasz odpowiedź w formacie JSON z aplikacji klienta.
Chociaż ta wiedza jest pomocna, aby zrozumieć, jak działa transfer danych, nie jest niezbędna, aby zacząć wykonywać wywołania API i czerpać wartość z tego, co oferują API Klaviyo. Poniższe sekcje wyjaśniają podstawy, a podlinkowany przewodnik Postman przeprowadzi Cię przez pierwsze wywołanie API.
Metody HTTP
Metody HTTP to „czasowniki”, za pomocą których wysyłane są Twoje żądania. W tym przewodniku omówimy 2 metody HTTP: GET i POST.
Chociaż nie będziemy ich tutaj używać, warto zaznaczyć, że większość interfejsów API REST obsługuje dodatkowe metody HTTP, takie jak PUT, PATCH i DELETE.
UZYSKAJ
Żądanie GET najłatwiej rozumieć jako żądanie „odczytu”. Żądania GET pobierają informacje z punktu końcowego API i zwracają je w odpowiedzi w formacie JSON. Te żądania pozwalają tylko odczytywać dane, co czyni je najbezpieczniejszym typem żądania, ponieważ przy użyciu tej metody nie można modyfikować ani nadpisywać danych.
ZAMIEŚĆ
Żądanie POST można najprościej rozumieć jako żądanie „zapisu”. POST umożliwia tworzenie lub dodawanie nowych zasobów. Na przykład żądanie POST do API list może posłużyć do utworzenia nowej listy na Twoim koncie, a żądania GET mogą pobierać Twoje listy strona po stronie. W każdej odpowiedzi klikaj link do następnej strony, aż nie będzie już kolejnych stron.
Sprawdź dokumentację referencyjną punktu końcowego, aby poznać jego odpowiedź sukcesu. Utworzenie listy zwraca 201 (Created) wraz z danymi nowej listy. Niektóre żądania POST, takie jak utworzenie zdarzenia, zwracają 202 (Accepted) bez treści odpowiedzi. Odpowiedź 202 oznacza, że żądanie zostało przyjęte do przetworzenia. Nie potwierdza to, że przetwarzanie zostało zakończone.
Niezbędne narzędzia
API oferują dużą elastyczność Twojej organizacji pracy i nie wymagają używania konkretnej aplikacji klienckiej ani biblioteki językowej, aby osiągnąć oczekiwane rezultaty. Ponieważ wywołania API są wykonywane za pomocą żądań HTTP, niemal każdy język programowania ma możliwość wysyłania tego typu żądań natywnie lub za pośrednictwem powszechnie dostępnej biblioteki językowej. Dodatkowo, w zależności od Twojego komputera i systemu operacyjnego, możesz używać natywnych aplikacji, takich jak Terminal firmy Apple lub Terminal systemu Windows, aby wykonywać wywołania API z poziomu komputera. Jednak te aplikacje wymagają wcześniejszej znajomości interfejsów wiersza poleceń.
Korzystamy z bezpłatnej aplikacji internetowej i desktopowej o nazwie Postman. Postman oferuje różne funkcje, które ułatwiają skonfigurowanie i wysłanie żądania API poprzez wprowadzenie punktu końcowego, parametrów i uwierzytelniania w przyjaznym interfejsie użytkownika.
Testowanie interfejsów API Klaviyo
Użyj konta testowego Klaviyo do eksperymentowania. Żądania POST mogą zmieniać dane w koncie powiązanym z Twoimi danymi uwierzytelniającymi, nawet gdy wysyłasz je z Postmana.
W przypadku żądań, które używają prywatnego klucza API, utwórz klucz z uprawnieniami wymaganymi przez punkty końcowe, które planujesz testować. Na przykład pobieranie list wymaga lists:read, a tworzenie listy wymaga lists:write. Trzymaj prywatne klucze API w bezpiecznym miejscu i nigdy nie ujawniaj ich w kodzie przeglądarki.
Interfejsy API Klaviyo są przydatne do wysyłania danych z innych platform lub serwerów do kont Klaviyo albo do wyszukiwania informacji w ramach konta Klaviyo. Teraz, gdy wiesz już, jak działają API, możesz zacząć testować nasze API pod kątem przypadków użycia w Twojej firmie. Pełną listę dostępnych interfejsów API Klaviyo znajdziesz w naszej dokumentacji referencyjnej API. Skorzystaj z naszego przewodnika dotyczącego korzystania z naszych kolekcji Postman , aby wykonać swoje pierwsze wywołanie API Klaviyo.
Dodatkowe źródła
Zasoby portalu deweloperskiego
Portal deweloperski Klaviyo zawiera przewodniki po API i dokumentację referencyjną, które pomogą maksymalnie wykorzystać nasze API. Zapoznaj się z poniższymi zasobami, aby zacząć:
- Dokumentacja referencyjna API Klaviyo
- Pierwsze kroki z API JavaScript
- Konfigurowanie transakcyjnych zdarzeń opartych na API
szkolenie dla Klaviyo Developers
Akademia Klaviyo oferuje szkolenia dla programistów, które pomogą zacząć tworzenie z użyciem API Klaviyo. Sprawdź szkolenia poniżej: