API: Autoryzacja

POST /user/auth

Endpoint służący otrzymania danych użytkownika w tym tokenu uwierzytelniania, logowanie przy pomocy loginu i hasła lub uwierzytelnienie wcześniej otrzymanym tokenem.

Parametry JSON

Klucz	Typ	Przykład	Opis	Wymagane
auth_method	string	credentials	Metoda uwierzytelnienia: credentials - dla loginu i hasła api_token - dla tokenu przechowywanego w aplikacji url_token - dla tokenu pobranego z linka logowania anonymous - prośba o token dla użytkownika anonimowego	Tak
auth_login	string	jankowalski@domena.pl	Login użytkownika	Tak, gdy auth_method = credentials
auth_password	string	BardzoTrudneHasło123	Hasło użytkownika	Tak, gdy auth_method = credentials
auth_token	string	2580f055d57a2a298cb899f8ede75edbb88f1c92	Token uwierzytelnienia	Tak, gdy auth_method = *_token

Należy pamiętać o wymaganych parametrach: API: Parametry

Odpowiedź JSON

{"auth":{"api_token":"2580f055d57a2a298cb899f8ede75edbb88f1c92","token_expire_dt":"2023-12-21T14:40:23"},"user":{"name":"Jan Testowy","email":"jankowalski@domena.pl"}}

Klucz	Typ	Przykład	Opis
auth	array		Tablica z danymi autoryzacji
auth.api_token	string	2580f055d57a2a298cb899f8ede75edbb88f1c92	Token uwierzytelnienia, należy go przechowywać w pamięci aplikacji, służy do autoryzowania w pozostałych endpointach api
auth.token_expire_dt	datetime	2023-12-21T14:40:23	Data i czas wygaśnięcia tokenu
user	UserObject	API: UserObject	Obiekt użytkownika patrz: API: UserObject

POST /user/reset

Endpoint służący resetowaniu dostępu użytkownika - "zapomniałem hasła"

Proces będzie przebiegał w 3 etapach:

1. na pierwszym ekranie użytkownik wpisze email swojego konta,
2. na drugim ekranie użytkownik może wpisać kod otrzymany mailem,
3. na trzecim ekranie użytkownik wpisuje nowe hasło

Parametry JSON

Klucz	Typ	Przykład	Wymagane w kroku	Opis
auth_login	string	jankowalski@domena.pl	1, 2, 3	Login użytkownika
reset_code	string	594834	2, 3	Kod potwierdzający otrzymany emailem
auth_password	string	BardzoTrudneHasło123	3	Nowe hasło

Należy pamiętać o wymaganych parametrach: API: Parametry

Odpowiedź JSON

{"result":"ok"}}

Klucz	Typ	Przykład	Opis
result	string	ok	ok - poprawnie przetworzona prośba, należy przejść do kolejnego kroku error - błąd przetwarzania
error	string	wrong_reset_code	Kod błędu: wrong_reset_code - błędny kod wrong_login - błędny login wrong_password - błędne hasło (min 8 znaków) no_input - brak argumentów