Przejdź do treści

Pobieranie listy zgód

Z platformy ExpertSender CDP możesz pobrać kompletną listę zgód na komunikację udzielonych przez Twoich klientów.  Ustawienia > Zgody > Zgody.

Więcej na ten temat przeczytasz tutaj: Zgody klientów

Pobieranie listy zgód – metoda GET

Do pozyskania listy wszystkich aktualnych zgód wraz z ich właściwościami służy metoda GET.

Żeby wysłać zapytanie z jej użyciem, musi ono zawierać:

  1. Adres serwera (endpoint): https://api.ecdp.app/customerconsents
  2. API key: twój klucz API, który znajdziesz w Ustawienia > API

Prawidłowe zapytanie API dotyczące listy cech klientów wygląda następująco: https://api.ecdp.app/customerconsents

Jakie dane znajda się w odpowiedzi

Odpowiedź na prawidłowo złożone zapytanie zawiera następujące dane:

ParametrTypOpis
idInteger($int32)Numer identyfikacyjny cechy zamówienia widoczny w platformie w Ustawienia > Zgody > Zgody.
namestringNazwa cechy zamówienia nadana przez Ciebie w Ustawienia > Zgody > Zgody.
typestringTyp cechy wraz z ich właściwościami: General, Email, Sms.

Kody odpowiedzi na zapytanie

200: Success

Zapytanie zostało przetworzone, serwer zwrócił odpowiedź.

Przykładowa składnia odpowiedzi:

{
  "status": 0,
  "data": [
    {
      "id": 0,
      "name": "string",
      "type": "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"
}