Zdarzenia niestandardowe w scenariuszach – metody API

Dzięki API zautomatyzujesz dodawanie danych dotyczących niestandardowych zdarzeń użytych w scenariuszach. Dostępna metoda dla tych działań to POST.

Metoda POST – dodawanie zdarzeń niestandardowych do scenariuszy

Ż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	Opis
customerId	string	numer ID klienta
customerEmail	string	adres e-mail klienta; minimalna ilość znaków: 0, maksymalna ilość znaków: 320
customerEmailMd5	string	adres e-mail klienta szyfrowany za pomocą algorytmu Md5; minimalna ilość znaków: 0, maksymalna ilość znaków: 32
customerEmailSha256	string	adres e-mail klienta szyfrowany za pomocą algorytmu Sha256; minimalna ilość znaków: 0, maksymalna ilość znaków: 64
customerPhone	string	numer telefonu klienta; minimalna ilość znaków: 0, maksymalna ilość znaków: 20
customerCrmId	string	numer CRM ID klienta; minimalna ilość znaków: 0, maksymalna ilość znaków: 128
dataFields		dodatkowe dane opisujące zdarzenie niestandardowe; obejmuje dodatkowy zestaw parametrów >>> zobacz tabele poniżej

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śc danej

Metoda POST – składnia zapytania

Poniżej znajdziesz przykładową składnię, za pomocą której dodasz zdarzenia niestandardowe do scenariusza.

Składnia zawiera parametry charakterystyczne dla zapytań API dotyczących zamówień, takie jak: customerEventId, customerEmailMd5, customerEmailSha256.

{
  "customEventId": 0,
  "customerId": 0,
  "customerEmail": "string",
  "customerEmailMd5": "string",
  "customerEmailSha256": "string",
  "customerPhone": "string",
  "customerCrmId": "string",
  "dataFields": [
    {
      "name": "string",
      "type": "String",
      "value": "string"
    }
  ]
}

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"
}