Trigger API

This post is also available in:

Wyzwalacze API służą do wysyłania wiadomości e-mail (w czasie rzeczywistym) poprzez wywołanie interfejsu API Samba po stronie klienta. Można ich użyć na przykład do wysłania specjalnej oferty po rejestracji klienta (lub w innych sytuacjach).

Jak działa API Trigger?

• E-maile są wysyłane natychmiast po wywołaniu API, niezależnie od tego, czy dany adres e-mail znajduje się w danej chwili w bazie danych.
• Możesz użyć statycznego lub spersonalizowanego szablonu z maksymalnie dziesięcioma spersonalizowanymi produktami. Jeśli klient (do którego wywoływany jest wyzwalacz API) znajduje się już w bazie danych, spersonalizowane produkty zmienią się na podstawie jego historii zakupów.
• Wywołania API uwzględniają każdy parametr klienta z wartością, którą można ustawić bezpośrednio z interfejsu Samba.

Jak skonfigurować wyzwalacz API w Sambie

1. Z menu głównego po lewej stronie wybierz zakładkę Triggery > Trigger API
2. Wybierz Nowa kampania
3. Konfiguracja kampanii:

Szablon:

Nazwa: Musi być taka sama jak nazwa kampanii w samym żądaniu API (w naszym przypadku API_Trigger_Test)

Product Filter: Filtruj produkty na podstawie wspólnych opcji segmentacji.

Szablon – Obsługiwane są tylko typy szablonów wiadomości Segmentacja i Spersonalizowany.

• Szablon może wyświetlać dowolny ustawiony parametr.
• Wprowadź parametry przy użyciu następującego formatu:

{{customer_custom_param_*vasParameter*}}

*vasParameter* może zawierać dowolne znaki alfanumeryczne (A-Z+a-z+0-9, z uwzględnieniem wielkości liter)

• Jeśli wywołanie API nie zawiera wspomnianego parametru w szablonie (lub używa pustego ciągu jako wartości), nic nie zostanie wyświetlone.
• Korzystając ze składni Mustache.js (https://mustache.github.io/mustache.5.html) można używać bloków IF/ELSE, na przykład:
  • {{#customer_custom_param_product2Title}}
Ta część szablonu jest wyświetlana jeśli wywołanie API zawiera parametr "product2Title" i nie ma pustego ciągu jako wartości.
{{/customer_custom_param_product2Title}}
  • {{^customer_custom_param_product2Title}}
Ta część szablonu zostanie wyświetlona, jeśli wywołanie API nie zawiera parametru "product2Title" lub ma pusty ciąg jako wartość.
{{/customer_custom_param_product2Title}}

Ustawienia e-mail:

Informacje e-mail: Temat, Nagłówek

Śledzenie wydajności: Parametry UTM

• Po zakończeniu można kliknąć Zapisz i zamknij. Wiadomość e-mail zostanie wysłana natychmiast po wywołaniu wyzwalacza API, jeśli nazwa pasuje do kampanii w Sambie i jest aktywna.

Jak działa wywołanie wyzwalacza API?

POST
https://api.samba.ai/shop/XX/send-trigger-mail
header: X-Api-Key: your-api-key
{

"email": "foo@bar.com",

"campaignName": "Triggered Campaign",
"customCustomerParameters": {
"parameter1name": "parameter1value",
"parameter2name": "parameter2value"
}
}

• xx – Samba ID twojego sklepu internetowego
• your-api-key – klucz API dla twojego sklepu (skontaktuj się z nami, aby go wygenerować)
• email – adres e-mail, na który chcesz wysłać wiadomość
• campaignName – nazwa kampanii, która jest taka sama jak nazwa kampanii w Sambie
• customCustomerParameters – opcjonalne, pary klucz-wartość
• parameter1name – nazwa parametru, którego wartość ma być wyświetlana w szablonie wiadomości e-mail
  • może zawierać tylko znaki alfanumeryczne (A-Z+a-z+0-9, wielkość liter ma znaczenie)
• parameter1value – wartość parametru, którego wartość ma być wyświetlana w szablonie wiadomości e-mail.
  • Jeśli nie znasz wartości wywołania API, nie używaj tego parametru lub użyj pustego ciągu jako wartości

Przykład

curl -H 'X-Api-Key:vas-api-klic' -d '{"email": "foo@bar.com", "campaignName": "My API campaign"}' https://api.samba.ai/shop/00/send-trigger-mail

Możliwe odpowiedzi

• success
  • HTTP 200 {„status”: „ok”}
• nieprawidłowe dane wejściowe
  • HTTP 200 { „status”: „error”, „error”: „invalidInput” }
  • HTTP 200 { „status”: „error”, „error”: „noSuchCampaign” }
  • HTTP 200 { „status”: „error”, „error”: „campaignDisabled” }
• error
  • HTTP 4xx
  • HTTP 5xx

This post is also available in: