API trigger

API triggery slouží k odesílání e-mailů (v reálném čase) zavoláním Samba API ze strany klienta. Lze je využít například pro odeslání speciální nabídky po registraci zákazníka (či jiných situacích).

Jak API Trigger funguje?

  • E-mail se odešle okamžitě po zavolání API, nehledě na to, zda je konkrétní e-mailová adresa v té chvíli ve Vaší databázi.
  • Můžete použít statickou či personalizovanou šablonu s až deseti personalizovanými produkty. Pokud je zákazník (na kterého je API trigger zavolaný) již v databázi, budou se personalizované produkty měnit na základě jeho nákupní historie.
  • API volání bere v potaz jakýkoliv zákaznický parametr s hodnotou, kterou můžete nastavit přímo z rozhraní Samby.

Jak API Trigger v Sambě nastavit?

  1. V hlavním menu po levé straně vyberte záložku API Trigger
  2. Vyberte Nová kampaň
  3. Nastavení kampaně:

Šablona:

Název: Musí být stejný jako campaignName v samotném API requestu (v našem případě API_Trigger_Test)

Produktový filtr: Filtrování produktů na základě běžných segmentačních možností.

Šablona: Podporovány jsou pouze šablony typu Segmentace a Personalizace.

  • Šablona může zobrazit jakýkoliv parametr, který si nastavíte.
  • Parametry vkládejte pomocí následujícího formátu:
    • {{customer_custom_param_*vasParametr*}}
      • *vasParametr* může obsahovat jakékoliv alfanumerické znaky (A-Z+a-z+0-9, závislé na velkých/malých písmenech)
  • Pokud nebude Vaše API volání obsahovat zmíněný parametr v šabloně (nebo bude použit prázdný řetězec jako hodnota), pak se nic nezobrazí.
  • Pomocí syntaxu Mustache.js (https://mustache.github.io/mustache.5.html) lze využít IF/ELSE bloky, tedy například:
    • {{#customer_custom_param_product2Title}}
      Tato část šablony se nezobrazí, pokud API volání neobsahuje parametr "Product2Title", nebo má jako hodnoutu prázdný řetězec.
      {{/customer_custom_param_product2Title}}
    • {{^customer_custom_param_product2Title}}
      Tato část šablony se zobrazí, pokud API volání neobsahuje parametr "Product2Title", nebo má jako hodnoutu prázdný řetězec.
      {{/customer_custom_param_product2Title}}

Nastavení e-mailu:

Informace o emailu: Předmět, záhlaví

Sledování výkonu: UTM parametry

  • Po dokončení můžete kliknout na Uložit a zavřít. E-mail bude odeslaný okamžitě po zavolání API triggeru, pokud se název shoduje s kampaní v Sambě a je aktivní.

Jak funguje volání API Triggeru?

POST
https://api.samba.ai/shop/XX/send-trigger-mail
header: X-Api-Key: vas-api-klic
{
  "email": "foo@bar.com",
  "campaignName": "Triggered Campaign",
  "customCustomerParameters": {
"parameter1name": "parameter1value",
"parameter2name": "parameter2value"
   }
}
  • xx – Samba ID Vašeho eshopu
  • your-api-key – API klíč pro Váš eshop (pro vygenerování nás, prosím, kontaktujte)
  • email – emailová adresa, na kterou chcete email zaslat
  • campaignName – název kampaně, která je stejná jako název kampaně v Sambě
  • customCustomerParameters – volitelné, páry klíčových hodnot
  • parameter1name – název parametru, jehož hodnotu chcete zobrazit v šabloně emailu
    • může obsahovat pouze alfanumerické znaky (A-Z+a-z+0-9,citlivý na velká písmena)
  • parameter1value – hodnota parametru, jehož hodnotu chcete zobrazit v šabloně emailu
    • Pokud neznáte hodnotu pro API volání, nepoužívejte tento parametr, nebo použijte jako hodnotu prázdný řetězec

Příklad

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

Možné odpovědi

  • success
    • HTTP 200 { “status”: “ok”}
  • invalid input
    • HTTP 200 { “status”: “error”, “error”: “invalidInput” }
    • HTTP 200 { “status”: “error”, “error”: “noSuchCampaign” }
    • HTTP 200 { “status”: “error”, “error”: “campaignDisabled” }
  • error
    • HTTP 4xx
    • HTTP 5xx

V závislosti na Vašem účtu může být nutné využít endpoint „https://api.yottly.com“. Pro bližší informace, prosím, kontaktujte naší podporu.

This post is also available in: English (Angličtina)

Upraveno 16 září, 2020

Byl pro vás tento článek užitečný?

Mohlo by vás zajímat