This post is also available in:
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?
- V hlavním menu po levé straně vyberte záložku API Trigger
- Vyberte Nová kampaň
- 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 zobrazí, pokud API volání obsahuje parametr "product2Title" a nemá jako hodnotu 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 hodnotu 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?
Endpoint URL
V závislosti na vašem účtu zvolte odpovídající URL endpointu.
- Pokud se přihlašujete na adrese app.samba.ai –> zvolte URL
api.samba.ai - Pokud se přihlašujete na adrese enterprise.samba.ai –> zvolte URL
api.yottly.com
ID vašeho účtu naleznete v sekci Nastavení jako součást vašeho unikátního trackovacího skriptu.
POSThttps://api.samba.ai/shop/XX/send-trigger-mailheader: X-Api-Key: vas-api-klic{ "email": "foo@bar.com",
"campaignName": "Triggered Campaign",
"customCustomerParameters": {
"parameter1name": "parameter1value",
"parameter2name": "parameter2value"
}
}xx– Samba ID Vašeho eshopuyour-api-key– API klíč pro Váš eshop (pro vygenerování nás, prosím, kontaktujte)email– emailová adresa, na kterou chcete email zaslatcampaignName– název kampaně, která je stejná jako název kampaně v SamběcustomCustomerParameters– volitelné, páry klíčových hodnotparameter1name– 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
This post is also available in: