1. Domů
  2. Samba
  3. Extra
  4. Export stavu přihlášení zákazníka přes API

Export stavu přihlášení zákazníka přes API

Díky tomuto API můžete synchronizovat stav přihlášení zákazníka k odběru newsletteru v Sambě s vaším systémem. Můžete načíst celý seznam, nebo jen změny (jen zákazníky, u nichž se změnil stupeň přihlášení k odběru newsletteru v intervalu <from,now>). Také si můžete zvolit, zda vyžadujete jen přihlášené, nebo odhlášené zákazníky.

GET
https://api.samba.ai/shop/sambaId/subscriptions?from=YYYY-MM-DD&state=subscription_state
header: X-Api-Key: your-api-key
  • sambaId – Samba ID vašeho e-shopu
  • your-api-key – Samba API klíč k vašemu e-shopu (Prosíme, v případě zájmu o API klíč nás neváhejte kontaktovat.)
  • from – nepovinný parametr, datum ve formátu YYYY-MM-DD (čas je nastaven na 00:00 v časovém pásmu Prahy (+1:00)). V případě vynechání tohoto parametru se exportuje celá historie.
  • state – nepovinný parametr, vyberte z: subscribedunsubscribed. V případě, že tento parametr vynecháte, exportují se všechny stupně přihlášení.

Odezva

JSON format – stream, one json object per line (application/json-seq):

{"customerId":"XYZ123", //ID zákazníka
  "email":"xyz123@yottly.com", // emailová adresa zákazníka
  "newsletterFrequency":"every day", //momentální stupeň přihlášení zákazníka k odběru novinek: "every day"/"special occasions" = subscribed, "never" = unsubscribed
  "since":1526481188957 //timestamp (v milisekundách) změny stupně přihlášení
}

Příklad

curl -H 'X-Api-Key: key' 'https://api.samba.ai/shop/4541245641234564/subscriptions?from=2018-04-19'
{"customerId":"XYZ123","email":"xyz123@yottly.com","newsletterFrequency":"every day","since":1526481188957}
{"customerId":"ABC123","email":"abc123@yottly.com","newsletterFrequency":"never","since":1526481188957}
{"customerId":"XAZ1R3","email":"xaz1r3@yottly.com","newsletterFrequency":"every day","since":1526481188957}
curl -H 'X-Api-Key: key' 'https://api.samba.ai/shop/4541245641234564/subscriptions?from=2018-04-19&state=subscribed'
{"customerId":"XYZ123","email":"xyz123@yottly.com","newsletterFrequency":"every day","since":1526481188957}
{"customerId":"XAZ1R3","email":"xaz1r3@yottly.com","newsletterFrequency":"every day","since":1526481188957}
Upraveno Duben 4, 2019

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

Mohlo by vás zajímat