API: Autoryzacja: Różnice pomiędzy wersjami
Przejdź do nawigacji
Przejdź do wyszukiwania
Nie podano opisu zmian |
Nie podano opisu zmian |
||
| Linia 68: | Linia 68: | ||
|[[API: UserObject]] | |[[API: UserObject]] | ||
|Obiekt użytkownika patrz: [[API: UserObject]] | |Obiekt użytkownika patrz: [[API: UserObject]] | ||
|} | |||
== POST /user/reset == | |||
Endpoint służący resetowaniu dostępu użytkownika - "zapomniałem hasła" | |||
=== Parametry JSON === | |||
{| class="wikitable" | |||
!Klucz | |||
!Typ | |||
!Przykład | |||
!Opis | |||
|- | |||
|auth_login | |||
|string | |||
|jankowalski@domena.pl | |||
|Login użytkownika | |||
|} | |||
Należy pamiętać o wymaganych parametrach: [[API: Parametry]] | |||
=== Odpowiedź JSON === | |||
<code><nowiki>{"result":"ok"}}</nowiki></code> | |||
{| class="wikitable" | |||
!Klucz | |||
!Typ | |||
!Przykład | |||
!Opis | |||
|- | |||
|result | |||
|string | |||
|ok | |||
|ok - poprawnie przetworzona prośba o reset hasła | |||
error - błąd przetwarzania | |||
|} | |} | ||
Wersja z 12:24, 26 mar 2024
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 |
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"
Parametry JSON
| Klucz | Typ | Przykład | Opis |
|---|---|---|---|
| auth_login | string | jankowalski@domena.pl | Login użytkownika |
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 o reset hasła
error - błąd przetwarzania |