Urządzenia mobilne – rejestracja i wyrejestrowanie

Użyj metod POST i DELETE, aby połączyć telefon lub tablet klienta z Twoją aplikacją mobilną. Dzięki temu możesz wysyłać powiadomienia push i mieć kontrolę nad zgodami związanymi z aplikacją.

POST /customermobiledevices – rejestracja lub aktualizacja urządzenia

Metoda POST rejestruje urządzenie, które zainstalowało aplikację mobilną lub aktualizuje jego dane, jeśli urządzenie jest już powiązane z aplikacją. Dodatkowo łączy urządzenie z profilem klienta i dodaje zgodę powiązaną z daną aplikacją, jeśli klient jeszcze jej nie ma.

Endpoint

POST /customermobiledevices

Host: https://api.ecdp.app

Parametry zapytania

Parametr	Lokalizacja	Typ	Wymagane	Opis	Dozwolone wartości / uwagi
x-api-key	header	string	tak	Klucz API do uwierzytelniania.	Dostępny w Ustawienia > API.
Content-Type	header	string	tak	Typ zawartości zapytnia.	application/json
mobileApplicationId	body	integer	tak	Aplikacja mobilna, do której ma być przypisane urządzenie.	ID Twojej aplikacji dostępne w Ustawienia > Aplikacje mobilne.
device	body	object	tak	Dane urządzenia.	Zobacz Dane urządzenia poniżej.
customer	body	object	nie	Identyfikacja klienta.	Zobacz Dane klienta poniżej.

Dane urządzenia

Parametr	Lokalizacja	Typ	Wymagane	Opis	Dozwolone wartości / uwagi
deviceId	body	string	tak	Unikalny identyfikator urządzenia lub instalacji aplikacji.	Maks. 50 znaków.
token	body	string	tak	Token push wydany przez Firebase Cloud Messaging (FCM).	Maks. 200 znaków.
osType	body	string	nie	System operacyjny urządzenia.	Android, Ios, WindowsPhone, Unknown.
osVersion	body	string	nie	Wersja systemu operacyjnego.	Maks. 50 znaków.
deviceBrand	body	string	nie	Producent urządzenia.	Maks. 50 znaków.
deviceModel	body	string	nie	Model urządzenia.	Maks. 50 znaków.
appVersion	body	string	nie	Wersja Twojej aplikacji mobilnej zainstalowanej na urządzeniu.	Maks. 50 znaków.
language	body	string	nie	Język urządzenia lub aplikacji.	Maks. 10 znaków.

Dane klienta

Użyj tych pól, aby połączyć urządzenie z profilem istniejącego klientem. Podaj co najmniej jeden z parametrów: email, phone lub crmId, aby zidentyfikować klienta. Jeśli je pominiesz, urządzenie zostanie zarejestrowane samodzielnie, bez powiązania z klientem.

Parametr	Lokalizacja	Typ	Wymagane	Opis	Dozwolone wartości / uwagi
email	body	string	warunkowo	Adres e-mail klienta.	Maks. 320 znaków.
phone	body	string	warunkowo	Numer telefonu klienta.	Maks. 20 znaków, bez spacji.
crmId	body	string	warunkowo	Identyfikator CRM klienta.	Maks. 1280 znaków.

Jeden klient może mieć zarejestrowanych kilka urządzeń jednocześnie, na przykład telefon i tablet – każde z własną subskrypcją.

Przykładowe zapytanie

Zarejestruj urządzenie i połącz je z klientem

Wymagany format: JSON

{
  "mobileApplicationId": 1,
  "device": {
    "deviceId": "device123...",
    "token": "fcm_token...",
    "osType": "Android",
    "osVersion": "14",
    "deviceBrand": "Samsung",
    "deviceModel": "Galaxy S23",
    "appVersion": "2.4.1",
    "language": "en"
  },
  "customer": {
    "email": "anna.kowalska@domena.pl",
    "phone": "48987654321",
    "crmId": "CRM-005678"
  }
}

Kody odpowiedzi

Kod	Status	Opis
201	Created	Rejestracja została przyjęta i skierowana do przetwarzania.
400	Bad request	Nieprawidłowe parametry lub brak wymaganych pól.
401	Unauthorized	Brak klucza API lub nieprawidłowy klucz API.

DELETE /customermobiledevices – dezaktywacja rejestracji urządzenia

Użyj tej metody, gdy klient rezygnuje z powiadomień push lub odinstalowuje aplikację. Metoda oznacza pasujące urządzenie jako nieaktywne. Jeśli było to ostatnie aktywne urządzenie klienta dla danej aplikacji, powiązana zgoda zostaje automatycznie cofnięta – nie musisz zarządzać tym osobno.

Endpoint

DELETE /customermobiledevices

Host: https://api.ecdp.app

Parametry zapytania

Parametr	Lokalizacja	Typ	Wymagane	Opis	Dozwolone wartości / uwagi
x-api-key	header	string	tak	Klucz API do uwierzytelniania.	Dostępny w Ustawienia > API.
mobileApplicationId	body	integer	tak	Aplikacja mobilna, do której przypisane jest urządzenie.	Ta sama wartość użyta podczas rejestracji urządzenia.
deviceId	body	string	tak	Urządzenie do dezaktywacji.	Ta sama wartość użyta podczas rejestracji urządzenia.

Przykładowe zapytanie

Dezaktywuj urządzenie

Format żądania: JSON

{
  "mobileApplicationId": 1,
  "deviceId": "device123..."
}

Kody odpowiedzi

Kod	Status	Opis
200	OK	Rejestracja urządzenia została pomyślnie dezaktywowana
401	Unauthorized	Brak klucza API lub nieprawidłowy klucz API

Walidacja i zasady i działania

POST jest idempotentny – ponowne wywołanie z tym samym urządzeniem aktualizuje zapisany token i dane, zamiast tworzyć nowy wpis.
Przetwarzanie POST odbywa się w tle, więc odpowiedź 201 potwierdza, że zapytanie zostało przyjęte – a nie że przetwarzanie zostało zakończone.
Rejestracja urządzenia dodaje zgodę powiązaną z daną aplikacją mobilną, jeśli klient jeszcze jej nie ma.

Dokumentacja referencyjna

Swagger – CustomerMobileDevices

https://api.ecdp.app/swagger/index.html