API: Autoryzacja: Różnice pomiędzy wersjami

Z DrRobert DOCS
Przejdź do nawigacji Przejdź do wyszukiwania
Nie podano opisu zmian
Nie podano opisu zmian
Linia 64: Linia 64:
|-
|-
|user
|user
|array
|UserObject
|
|
|Tablica z danymi użytkownika
|Obiekt użytkownika patrz: [[API: UserObject]]
|-
|user.name
|string
|Jan Testowy
|Nazwa użytkownika
|-
|user.email
|string
|jankowalski@domena.pl
|E-mail użytkownika
|}
|}

Wersja z 12:23, 21 gru 2023

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:
  1. credentials - dla loginu i hasła
  2. api_token - dla tokenu przechowywanego w aplikacji
  3. url_token - dla tokenu pobranego z linka logowania
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 Obiekt użytkownika patrz: API: UserObject