API: Rejestracja (konta i profile): Różnice pomiędzy wersjami

Z DrRobert DOCS
Przejdź do nawigacji Przejdź do wyszukiwania
WizualnieWikikod
Nie podano opisu zmian
Nie podano opisu zmian
 
(Nie pokazano 12 wersji utworzonych przez 2 użytkowników)
Linia 9: Linia 9:
!Opis
!Opis
!Wymagane
!Wymagane
!Walidacja
|-
|-
|name
|name
|string
|string
|
|Jan Kowalski
|
|Nazwa użytkownika: imię lub imię i nazwisko
|Tak
|Tak
|Długość: 50
|-
|-
|phone
|phone
|string
|string
|
| +48699999999
|
|Telefon
|
|Tak
|Cyfry i znak +; Długość: 20
|-
|-
|email
|email
|string
|string
|
|jankowalski@domena.pl
|
|E-mail
|
|Tak
|Adres email zgodny z RFC 5322 i RFC 6854, unikalny w skali serwisu
|-
|password
|string
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|-
|organization_id
|organisation_id
|integer
|integer
|
|1
|
|Organizacja (Placówka POZ)
|
|Nie
|ID organizacji (lista w [[API: Zasoby publiczne i konfiguracje ogólne]])
|-
|-
|agreements
|agreements
|array
|array
|
|[1:true,2:true,3:false]
|
|Zgody prawne
|
|Nie
|Tablica z id zgody i wartością bool jej akceptacji (lista w [[API: Zasoby publiczne i konfiguracje ogólne]])
|-
|-
|app_signature
|anonymous_token
|string
|string
|SDrRobSvWeb
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Podpis aplikacji
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Tak
|Nie
|-
|
|app_version
|string
|1.0.1-20231121
|Wersja aplikacji
|Tak
|}
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]


==== Odpowiedź poprawna ====
==== Odpowiedź poprawna ====
Linia 59: Linia 68:
'''JSON:'''
'''JSON:'''


<code><nowiki>{"auth":{"api_token":"2580f055d57a2a298cb899f8ede75edbb88f1c92","token_expire_dt":"2023-12-21T14:40:23"},"user":{"name":"Jan Testowy","email":"jankowalski@domena.pl"}}</nowiki></code>
<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
{| class="wikitable"
!Klucz
!Klucz
Linia 73: Linia 82:
|validation
|validation
|array
|array
|
|{"name": {"max": true},"phone": {"required": true},"email": {"email": true,"unique":true},"password":{"min":true},"organization_id": [],"agreements": []}
|Tablica z błędami walidacji
|Tablica z błędami walidacji, lista pól i występujących błędów
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.
 
=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|-
|auth.token_expire_dt
|name
|datetime
|string
|2023-12-21T14:40:23
|Jan Kowalski
|Data i czas wygaśnięcia tokenu
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]
 
==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|-
|user
|user
|array
|UserObject
|
|[https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|Tablica z danymi użytkownika
|Obiekt profilu patrz: [https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|-
|user.name
|string
|Jan Testowy
|Nazwa użytkownika
|-
|user.email
|string
|jankowalski@domena.pl
|E-mail użytkownika
|}
|}

Aktualna wersja na dzień 09:52, 6 maj 2024

POST /user/signup

Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

Parametry JSON

Klucz Typ Przykład Opis Wymagane Walidacja
name string Jan Kowalski Nazwa użytkownika: imię lub imię i nazwisko Tak Długość: 50
phone string +48699999999 Telefon Tak Cyfry i znak +; Długość: 20
email string jankowalski@domena.pl E-mail Tak Adres email zgodny z RFC 5322 i RFC 6854, unikalny w skali serwisu
password string BardzoTrudneHasło123 Nadane hasło Tak Minimum 8 dowolnych znaków
organisation_id integer 1 Organizacja (Placówka POZ) Nie ID organizacji (lista w API: Zasoby publiczne i konfiguracje ogólne)
agreements array [1:true,2:true,3:false] Zgody prawne Nie Tablica z id zgody i wartością bool jej akceptacji (lista w API: Zasoby publiczne i konfiguracje ogólne)
anonymous_token string 2580f055d57a2a298cb899f8ede75edbb88f1c92 Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego. Nie

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

Odpowiedź poprawna

Identyczna jak w API: Autoryzacja

Odpowiedź niepoprawna walidacja

JSON:

{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}

Klucz Typ Przykład Opis
error string validation Informacja o typie błędu, tutaj walidacja
validation array {"name": {"max": true},"phone": {"required": true},"email": {"email": true,"unique":true},"password":{"min":true},"organization_id": [],"agreements": []} Tablica z błędami walidacji, lista pól i występujących błędów

POST /user/profile

Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

Parametry JSON

Klucz Typ Przykład Opis Wymagane Walidacja
name string Jan Kowalski Nazwa profilu: imię lub imię i nazwisko Tak Długość: 50

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

Odpowiedź poprawna

Klucz Typ Przykład Opis
user UserObject API: UserObject Obiekt profilu patrz: API: UserObject
Źródło: „https://docs.doctorrobert.com/index.php?title=API:_Rejestracja_(konta_i_profile)&oldid=231”