Klienci – pobieranie listy cech
Za pomocą metody GET pobierzesz wszystkie cechy klienta skonfigurowane w Twojej jednostce biznesowej. Znajdziesz je w Ustawienia > Klienci > Cechy klientów.
Endpoint
Endpoint, czyli adres serwera dla tego zapytania to https://api.ecdp.app/customerattributes
Parametry zapytania
| Parametr | Lokalizacja | Typ | Wymagany | Opis | Dozwolone wartości / Uwagi |
| x-api-key | nagłówek | string | tak | Twój klucz API ECDP do uwierzytelniania. | Znajdziesz go w Ustawienia > API. |
Ten endpoint nie przyjmuje żadnych parametrów ani treści zapytania. Jedynym wymaganym elementem jest klucz API w nagłówku.
Odpowiedź
Odpowiedź zawiera status oraz tablicę z cechami klienta.
| Parametr | Typ | Opis |
| status | integer | Kod statusu odpowiedzi. Wartość 0 oznacza sukces. |
| data | array | Tablica z cechami klienta. Jeśli nie zdefiniowano żadnych cech, tablica będzie pusta. Zobacz custom attribute data. |
Custom attribute data
Każdy obiekt w tablicy reprezentuje jedną cechę klienta.
| Parametr | Typ | Opis |
| id | integer (int32) | Unikalny identyfikator cechy widoczny w Ustawienia > Klienci > Cechy klientów. |
| name | string | Nazwa cechy nadana w Ustawienia > Klienci > Cechy klientów. |
| type | string | Typ danych – określa, jakie wartości może przechowywać dana cecha. Zobacz sekcję Data types. |
Data types
Pole type zawiera jedną z poniższych wartości:
| Wartość | Opis |
| String | Krótka wartość tekstowa (jedna linia). |
| Text | Długa wartość tekstowa (wiele linii). |
| Number | Wartość liczbowa (liczba całkowita lub dziesiętna). |
| Money | Wartość walutowa z precyzją dziesiętną. |
| Date | Wartość daty bez składnika czasu (YYYY-MM-DD). |
| DateTime | Wartość daty i czasu (format ISO-8601). |
| SingleSelect | Pojedynczy wybór ze zdefiniowanych opcji. |
| Boolean | Wartość true/false. |
| Url | Wartość URL/adresu internetowego. |
Przykładowe zapytania i odpowiedzi
Pobieranie wszystkich cech niestandardowych
Odpowiedź (200 OK):
{
"status": 0,
"data": [
{
"id": 1,
"name": "Poziom lojalnościowy",
"type": "SingleSelect"
},
{
"id": 2,
"name": "Preferowany język",
"type": "String"
},
{
"id": 3,
"name": "Data urodzenia",
"type": "Date"
},
{
"id": 4,
"name": "Data zapisu na newsletter",
"type": "DateTime"
},
{
"id": 5,
"name": "wartosc_klienta",
"type": "Money"
}
]
}Odpowiedź niezawierająca cech klienta
Jeśli w ECDP cechy klienta nie zostały dodane, endpoint zwraca pustą tablicę ‘data’.
Odpowiedź (200 OK):
{
"status": 0,
"data": []
}Kody odpowiedzi
| Kod | Status | Opis |
| 200 | Sukces | Zapytanie przetworzone pomyślnie. Odpowiedź zawiera listę niestandardowych cech klienta. |
| 401 | Brak autoryzacji | Brakuje klucza API, jest nieprawidłowy lub wygasł. Sprawdź swój klucz API w Ustawienia > API. |
| 403 | Brak dostępu | Klucz API nie ma uprawnień do tego zasobu. |
| 500 | Błąd serwera | Wystąpił błąd po stronie serwera. Spróbuj ponownie lub skontaktuj się z pomocą techniczną, jeśli problem się powtarza. |
Walidacja i zasady działania
- Ten endpoint zwraca wyłącznie cechy klienta dodane w Ustawienia > Klienci > Cechy klientów. Cechy systemowe (email, telefon itp.) nie są uwzględniane.
- Identyfikatory cech są stałe i nie zmieniają się po utworzeniu.
Dokumentacja referencyjna
Swagger – sekcja Customer attributes