Źródła danych i API

Jak podłączyć źródło danych do własnego API

Ostatnia aktualizacja

Gdy podłączysz źródło danych API, Sendtric wysyła żądanie do twojego API, żeby pobrać dane subskrybenta w momencie otwarcia jego e-maila. Żadne dane nie są kopiowane do Sendtric, więc obrazki pokazują dokładnie to, co w danym momencie zwraca twoje API – na przykład aktualny status zamówienia czy dzisiejsze saldo konta.

Jeśli wolisz przesłać dane do Sendtric z wyprzedzeniem, zobacz jak wysyłać rekordy za pomocą API Sendtric.

Czego potrzebuje twoje API

  • An adres HTTPS , który jest dostępny z publicznej sieci internetowej.
  • Sposób na wywołanie jednego rekordu na podstawie jego identyfikatora, podanego w ścieżce lub w parametrze zapytania. Na przykład https://api.example.com/customers/12345.
  • A odpowiedź w formacie JSON z polami rekordu, takimi jak {"first_name": "Sarah", "points": 1250}.
  • Krótka odpowiedź: Sendtric czeka maksymalnie 5 sekund, a rozmiar odpowiedzi nie może przekraczać 1 MB.

Skonfiguruj to

  1. W lewym pasku bocznym kliknij Źródła danych, a potem Nowe źródło danych.
  2. W sekcji API, wybierz API i kliknij Kontynuuj.
  3. Wybierz Pobierz dane z API i kliknij Kontynuuj.
  4. Wpisz Nazwę źródła danych, Pole unikalnego identyfikatora (na przykład customer_id) oraz, jeśli chcesz, Opis.
  5. Wybierz metodę: GET lub POST.
  6. Wpisz adres URL swojego API i w tym miejscu {{uid}} w miejsce identyfikatora, na przykład https://api.example.com/customers/{{uid}}. Sendtric zastępuje {{uid}} na identyfikator każdego subskrybenta.
  7. Dodaj dowolne nagłówki potrzebne dla twojego API, np. Authorization wraz z tokenem API. Kliknij + Dodaj dla każdego z nich.
  8. Dodaj dowolne parametry zapytania. Jeśli Twoje API przyjmuje identyfikator jako parametr, wpisz {{uid}} jego wartość zamiast adresu URL, na przykład id = {{uid}}.
  9. Wpisz prawdziwy identyfikator w pole „Sprawdź wartość unikalnego identyfikatora” i kliknij Testuj API.
  10. Sprawdź odpowiedź, a potem kliknij Zapisz źródło danych.
Ustawienia opcji „Pobierz dane z API” z adresem URL zawierającym {{uid}}, nagłówkiem autoryzacji, wartością testową oraz pomyślną odpowiedzią testową

Zapisz źródło danych pozostaje wyłączona, dopóki test się nie powiedzie, a odpowiedź nie będzie zawierała co najmniej jednego pola. Jeśli zmienisz adres URL, metodę, nagłówki lub parametry, przeprowadź test ponownie.

Użyj punktu końcowego testowego albo dedykowanego tokenu API tylko do odczytu. Sendtric ukrywa wartości nagłówków po zapisaniu, więc żeby je zmienić, musisz wprowadzić je od nowa.

Jak działają wyszukiwania

  • Każde wyszukiwanie wysyła jedno żądanie do twojego API dla jednego subskrybenta.
  • Identyfikatory są wysyłane dokładnie tak, jak wypełnia je tag scalający, więc wielkość liter ma znaczenie, jeśli twoje API to uwzględnia.
  • Sendtric przechowuje wygenerowany obraz przez czasu przechowywania w pamięci podręcznej ustalony czas otwarcia w edytorze obrazów (od 2 do 60 minut), dzięki czemu wielokrotne otwieranie nie powoduje za każdym razem wywołania twojego API.
  • Jeśli twoje API działa wolno, zwraca błąd lub nie ma wpisu dla danego identyfikatora, wartość ta jest traktowana jako pusta. W spersonalizowanym zdjęciu ta warstwa jest ukryta, więc zaprojektuj zdjęcie tak, żeby nadal wyglądało dobrze bez niej.

Zmień połączenie

W Źródła danychkliknij źródło danych, żeby otworzyć jego ustawienia. Możesz zmienić adres URL, metodę, nagłówki i parametry, a potem uruchomić Test API przed zapisaniem.

Następny krok

Czy ten artykuł był pomocny?

Kliknij obraz, aby go powiększyć. Przeciągnij lub przewiń, aby się rozejrzeć.