API: Autoryzacja: Różnice pomiędzy wersjami
Przejdź do nawigacji
Przejdź do wyszukiwania
Nie podano opisu zmian |
Nie podano opisu zmian |
||
| Linia 8: | Linia 8: | ||
!Przykład | !Przykład | ||
!Opis | !Opis | ||
!Wymagane | |||
|- | |- | ||
|auth_method | |auth_method | ||
| Linia 15: | Linia 16: | ||
# credentials - dla loginu i hasła | # credentials - dla loginu i hasła | ||
# | # api_token - dla tokenu przechowywanego w aplikacji | ||
# url_token - dla tokenu pobranego z linka logowania | |||
|Tak, zawsze | |||
|- | |- | ||
|auth_login | |auth_login | ||
| Linia 21: | Linia 24: | ||
|jankowalski@domena.pl | |jankowalski@domena.pl | ||
|Login użytkownika | |Login użytkownika | ||
|Tak, gdy auth_method = credentials | |||
|- | |- | ||
|auth_password | |auth_password | ||
| Linia 26: | Linia 30: | ||
|BardzoTrudneHasło123 | |BardzoTrudneHasło123 | ||
|Hasło użytkownika | |Hasło użytkownika | ||
|Tak, gdy auth_method = credentials | |||
|- | |- | ||
|auth_token | |auth_token | ||
| Linia 31: | Linia 36: | ||
|2580f055d57a2a298cb899f8ede75edbb88f1c92 | |2580f055d57a2a298cb899f8ede75edbb88f1c92 | ||
|Token uwierzytelnienia | |Token uwierzytelnienia | ||
|Tak, gdy auth_method = token | |||
|} | |} | ||
==== Odpowiedź JSON ==== | ==== Odpowiedź JSON ==== | ||
<code><nowiki>{"auth":{" | <code><nowiki>{"auth":{"api_token":"2580f055d57a2a298cb899f8ede75edbb88f1c92"},"user":{"name":"Jan Testowy","email":"jankowalski@domena.pl"}}</nowiki></code> | ||
{| class="wikitable" | {| class="wikitable" | ||
!Klucz | !Klucz | ||
| Linia 46: | Linia 52: | ||
|Tablica z danymi autoryzacji | |Tablica z danymi autoryzacji | ||
|- | |- | ||
|auth. | |auth.api_token | ||
|string | |string | ||
|2580f055d57a2a298cb899f8ede75edbb88f1c92 | |2580f055d57a2a298cb899f8ede75edbb88f1c92 | ||
|Token uwierzytelnienia | |Token uwierzytelnienia, należy go przechowywać w pamięci aplikacji, służy do autoryzowania w pozostałych endpointach api | ||
|- | |- | ||
|user | |user | ||
Wersja z 13:39, 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, zawsze |
| 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 |
Odpowiedź JSON
{"auth":{"api_token":"2580f055d57a2a298cb899f8ede75edbb88f1c92"},"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 |
| user | array | Dane użytkownika |