Źródła danych i API

Jak wysłać rekordy do źródła danych za pomocą API Sendtric

Ostatnia aktualizacja

Dzięki źródłu danych API twój system wysyła rekordy JSON do Sendtric za każdym razem, gdy twoje dane ulegną zmianie. Sendtric przechowuje je jako dane hostowane, a twoje obrazy sprawdzają rekord każdego subskrybenta w momencie otwarcia wiadomości e-mail.

Ten przewodnik jest przeznaczony dla wszystkich, którzy piszą kod odpowiedzialny za wysyłanie danych. Jeśli wolisz, żeby Sendtric pobierał dane z Twojego API przy każdym otwarciu wiadomości, zajrzyj do jak podłączyć źródło danych do własnego API.

Utwórz źródło danych

  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 Wyślij dane do Sendtric i kliknij Kontynuuj.
  4. Wpisz:
    • Nazwa źródła danych: na przykład „Członkowie programu lojalnościowego”.
    • Pole unikalnego identyfikatora: pole JSON, które identyfikuje każdy rekord, np. customer_id lub email. Każdy wysyłany rekord musi je zawierać.
    • Opis (opcjonalnie).
  5. Kliknij Zapisz źródło danych. Źródło danych zostanie utworzone, a Krok wyświetli twoje punkty końcowe i klucz API.
  6. Skopiuj to, czego potrzebujesz, a potem kliknij Kontynuuj , żeby zakończyć.
Sekcja poświęcona API nowego źródła danych, zawierająca punkty końcowe do dodawania i aktualizacji pojedynczych rekordów oraz zbiorczej operacji „upsert”, klucz API oraz przykładowe żądania

W każdej chwili możesz ponownie znaleźć punkty końcowe w sekcji źródeł danych Szczegóły API .

Zaloguj się

Prześlij swój klucz w Authorization nagłówku każdego żądania:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

The Klucz API źródła danych działa wyłącznie do wysyłania rekordów źródła danych, więc możesz go bez obaw przekazać programiście lub narzędziu do automatyzacji. Jeśli korzystasz z planu API, Twój obecny klucz API działa również na tych punktach końcowych.

Nie umieszczaj swojego klucza w kodzie front-endu ani w publicznych repozytoriach. Jeśli kiedykolwiek zostanie ujawniony, wygeneruj go ponownie w sekcji Ustawienia → Klucze API → Klucz API źródła danych, a potem zaktualizuj wszystko, co go używa.

Utwórz lub zaktualizuj rekordy

Wyślij pojedynczy obiekt JSON lub tablicę obiektów na punkt końcowy pokazany w Sendtric. Jeden rekord:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "customer_id": "CUST_1001",
  "first_name": "Sarah",
  "points": 1250
}

Kilka rekordów w jednym zapytaniu:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

[
  { "customer_id": "CUST_1001", "first_name": "Sarah", "points": 1250 },
  { "customer_id": "CUST_1002", "first_name": "James", "points": 300 }
]

Jak zapisywane są dane:

  • Jeśli żaden rekord nie ma jeszcze tego identyfikatora, tworzony jest nowy.
  • Jeśli tak, to zostanie zastąpiony na to, co wysłałeś. Pola, których nie podasz, zostaną usunięte, więc zawsze wysyłaj pełny rekord.
  • Nowe i zaktualizowane wpisy są zazwyczaj dostępne w ciągu około minuty.
  • Identyfikatory są porównywane bez uwzględniania wielkości liter.

Pomyślne żądanie zwraca 200 krótkie podsumowanie, na przykład {"status":"ok","records":2}.

Możesz zagnieżdżać obiekty w rekordzie, na przykład "address": { "city": "Leeds" }, a w edytorze obrazów możesz wybrać pola zagnieżdżone.

Usuń rekordy

Aby usunąć jeden rekord, dodaj jego identyfikator na końcu adresu punktu końcowego:

DELETE <your data source endpoint>/cust_1001
Authorization: Bearer YOUR_API_KEY

Usuń kilka elementów, wysyłając tablicę identyfikatorów:

DELETE <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

["cust_1001", "cust_1002"]

Ograniczenia

LimitWartość
Liczba rekordów na zapytanie10 000
Rozmiar żądania10 MB
Wartość identyfikatora255 znaków
Dowolna pojedyncza wartość tekstowa10 KB
Głębokość zagłębienia20 poziomów

Wysyłaj rekordy partiami, zamiast wysyłać osobne żądania dla każdego rekordu. Jeśli masz do wysłania tysiące rekordów, zobacz jak wysyłać duże ilości danych do źródła danych.

Odpowiedzi i błędy

StatusCo to znaczyCo robić
200Przyjęte zapisyNic. Jeśli jakieś utwory zostały pominięte, nagłówek „X-Skipped-Records” podaje, ile ich było
400Treść nie jest poprawnym JSON-emSprawdź treść żądania
401Brakujący lub nieprawidłowy klucz APISprawdź nagłówek „Authorization”
404Nie znaleziono źródła danych dla tego kluczaSprawdź punkt końcowy i upewnij się, że klucz należy do tego samego konta
413Za dużo rekordów albo są za dużePodziel żądanie na mniejsze partie
422Nie udało się zapisać rekorduW komunikacie podano, w których rekordach brakuje pola identyfikatora lub które są za duże
503Sendtric ma pełne ręce robotyPoczekaj tyle sekund, ile podano w nagłówku „Retry-After”, a potem wyślij to samo żądanie jeszcze raz

Jeśli tylko niektóre rekordy w żądaniu są nieprawidłowe, te poprawne i tak są zapisywane, a reszta jest pomijana.

Sprawdź swoje dane

Otwórz źródło danych i przejdź do sekcji zakładki „Rekordy” . Wyszukaj według wartości identyfikatora i kliknij rekord, żeby zobaczyć pełny zapis JSON przechowywany przez Sendtric.

Następny krok

Czy ten artykuł był pomocny?

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