API: Autoryzacja: Różnice pomiędzy wersjami
Przejdź do nawigacji
Przejdź do wyszukiwania
Nie podano opisu zmian |
Nie podano opisu zmian |
||
| Linia 18: | Linia 18: | ||
# api_token - dla tokenu przechowywanego w aplikacji | # api_token - dla tokenu przechowywanego w aplikacji | ||
# url_token - dla tokenu pobranego z linka logowania | # url_token - dla tokenu pobranego z linka logowania | ||
|Tak | |Tak | ||
|- | |- | ||
|auth_login | |auth_login | ||
| Linia 37: | Linia 37: | ||
|Token uwierzytelnienia | |Token uwierzytelnienia | ||
|Tak, gdy auth_method = *_token | |Tak, gdy auth_method = *_token | ||
|- | |||
|app_signature | |||
|string | |||
|SDrRobSvWeb | |||
|Podpis aplikacji | |||
|Tak | |||
|- | |||
|app_version | |||
|string | |||
|1.0.1-20231121 | |||
|Wersja aplikacji | |||
|Tak | |||
|} | |} | ||
==== Odpowiedź JSON ==== | ==== Odpowiedź JSON ==== | ||
<code><nowiki>{"auth":{"api_token":"2580f055d57a2a298cb899f8ede75edbb88f1c92"},"user":{"name":"Jan Testowy","email":"jankowalski@domena.pl"}}</nowiki></code> | <code><nowiki>{"auth":{"api_token":"2580f055d57a2a298cb899f8ede75edbb88f1c92","token_expire_dt":"2023-12-21T14:40:23"},"user":{"name":"Jan Testowy","email":"jankowalski@domena.pl"}}</nowiki></code> | ||
{| class="wikitable" | {| class="wikitable" | ||
!Klucz | !Klucz | ||
| Linia 56: | Linia 68: | ||
|2580f055d57a2a298cb899f8ede75edbb88f1c92 | |2580f055d57a2a298cb899f8ede75edbb88f1c92 | ||
|Token uwierzytelnienia, należy go przechowywać w pamięci aplikacji, służy do autoryzowania w pozostałych endpointach api | |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 | |user | ||
Wersja z 13:51, 21 lis 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:
|
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 |
| app_signature | string | SDrRobSvWeb | Podpis aplikacji | Tak |
| app_version | string | 1.0.1-20231121 | Wersja aplikacji | Tak |
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 | array | Tablica z danymi użytkownika | |
| user.name | string | Jan Testowy | Nazwa użytkownika |
| user.email | string | jankowalski@domena.pl | E-mail użytkownika |