Klienci – pobieranie listy zgód
Metoda GET zwraca pełną listę zgód marketingowych skonfigurowanych w Twojej jednostce biznesowej. Dla każdej zgody otrzymasz jej unikalny identyfikator, nazwę oraz typ kanału komunikacji.
Endpoint
GET customerconsents
Host: https://api.ecdp.app
Parametry zapytania
| Parametr | Lokalizacja | Typ | Wymagany | Opis | Dozwolone wartości / Uwagi |
| x-api-key | nagłówek | string | tak | Klucz API do uwierzytelnienia. | Znajdziesz go w Ustawienia > API. Wyślij jako nagłówek żądania. |
Ten endpoint nie przyjmuje żadnych parametrów ani treści zapytania. Jedynym wymaganym elementem jest klucz API w nagłówku.
Odpowiedź
| Parametr | Typ | Opis |
| status | integer | Kod statusu odpowiedzi. Dla udanych żądań zwraca wartość 0. |
| data | array | Tablica z danymi zgód. Zobacz Customer consent data. |
Customer consent data
Każdy obiekt w tablicy reprezentuje pojedynczą zgodę i zawiera następujące parametry:
| Parametr | Typ | Opis |
| id | integer($int32) | Unikalny identyfikator zgody. Odpowiada identyfikatorowi widocznemu w Ustawienia > Zgody > Zgody. |
| name | string | Nazwa przypisana do zgody w Ustawienia > Zgody > Zgody. |
| type | string | Typ kanału komunikacji dla zgody. Dozwolone wartości: General, Email, Sms. |
Przykładowe zapytania i odpowiedzi
Pobieranie wszystkich list zgód
Odpowiedź (200 OK):
{
"status": 0,
"data": [
{
"id": 1,
"name": "Zapis na newsletter",
"type": "Email"
},
{
"id": 2,
"name": "SMS marketing",
"type": "Sms"
},
{
"id": 3,
"name": "Zmiany w regulaminach",
"type": "General"
}
]
}Pusta lista zgód
Gdy nie ma skonfigurowanych żadnych zgód, endpoint zwraca pustą tablicę ‘data’:
Odpowiedź (200 OK):
{
"status": 0,
"data": []
}Kody odpowiedzi
| Kod | Status | Opis |
| 200 | OK | Zapytanie przetworzone pomyślnie. Zwraca dane zgód. |
| 401 | Unauthorized | Brak klucza API, nieprawidłowy klucz lub niewystarczające uprawnienia do tego zasobu. |
Walidacja i zasady działania
- Zwracane są tylko zgody widoczne w Ustawienia > Zgody > Zgody.
- W odpowiedzi znajdziesz zarówno zgody systemowe, jak i te utworzone przez siebie.
- Pole ‘type’ wskazuje kanał komunikacji: General (zgoda ogólna, niezwiązana z konkretnym kanałem), Email (marketing e-mailowy) lub Sms (marketing SMS).
Dokumentacja referencyjna
Swagger – sekcja Customer consents