Zdarzenia niestandardowe w scenariuszach – metody API

Dzięki API zautomatyzujesz uruchamianie niestandardowych zdarzeń użytych w scenariuszach. Dostępna metoda dla tych działań to POST, która umożliwia:

Uruchomienie niestandardowego zdarzenia w scenariuszu dla wybranego klienta.
Uruchomienie niestandardowego zdarzenia w scenariuszu dla wybranego segmentu.

Metoda POST – uruchamianie zdarzeń niestandardowych dla wybranego klienta

Żeby wysłać zapytanie z użyciem tej metody, potrzebujesz następujących informacji:

Adres serwera (endpoint): https://api.ecdp.app/scenariocustomevents
Parametry:

Parametr	Typ	Kategoria	Opis
x-api-key	string	header	klucz API
customEventId*	integer($int32)	body	numer ID zdarzenia niestandardowego

Pozostałe parametry, które możesz dodać do zapytania:

Parametr	Typ	Maksymalna liczba znaków	Opis
customerId	header	body	numer ID klienta
customerEmail	string	320	adres e-mail klienta
customerEmailMd5	string	32	adres e-mail klienta szyfrowany za pomocą algorytmu Md5
customerEmailSha256	string	64	adres e-mail klienta szyfrowany za pomocą algorytmu Sha256
customerPhone	string	20	numer telefonu klienta
customerCrmId	string	128	numer CRM ID klienta
dataFields			dodatkowe dane opisujące zdarzenie niestandardowe; obejmuje dodatkowy zestaw parametrów >>> zobacz tabele poniżej

Parametry identyfikujące klienta są ułożone według priorytetu – od najwyższego do najniższego. Jeśli w zapytaniu podasz np. e-mail klienta oraz numer telefonu, odszukamy klienta w bazie po adresie e-mail.

Parametry dataFields posiada własne parametry, które pozwolą Ci na dodanie lub uzyskanie bardziej szczegółowych informacji.

Parametr	Typ	Opis
name	string	nazwa danej
type	string	typ danej: String, Text, Number, Money, Date, DateTime, Boolean, Url
value	string	wartość danej

Składnia zapytania

Poniżej znajdziesz przykładową składnię, za pomocą której uruchomisz zdarzenie niestandardowe dla wskazanego adresu e-mail:

{
  "customEventId": 101,
  "customerEmail": "client@example.com",
  "dataFields": [
    {
      "name": "Order ID",
      "type": "String",
      "value": "12345"
    },
    {
      "name": "Free Product",
      "type": "String",
      "value": "Headphones"
    }
  ]
}

Poniży przykład pokazuje, jak uruchomić zdarzenie niestandardowe dla wskazanego numeru telefonu:

{
  "customEventId": 102,
  "customerPhone": "+48600123456",
  "dataFields": [
    {
      "name": "Order ID",
      "type": "String",
      "value": "67890"
    },
    {
      "name": "Free Product",
      "type": "String",
      "value": "USB-C Cable"
    }
  ]
}

Kody odpowiedzi na zapytanie API

201: Created

Żądanie zostało utworzone.

400: Bad request

Żądanie nie zostało przetworzone, powodem jest zwykle brakujący lub nieprawidłowy parametr. Przykładowa składnia odpowiedzi:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "errors": [
    "string"
  ]
}

401: Unauthorized

W żądaniu brakowało klucza API lub prosisz o dostęp do informacji, do których nie masz uprawnień. Przykładowa składnia odpowiedzi:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404: Not found

Na serwerze nie ma danych, których szukasz. Przykładowa składania odpowiedzi:


{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Metoda POST – dodawanie klientów do aktywnego scenariusza na podstawie ich segmentów