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
Linia 87: Linia 87:
== POST /user/profile ==
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.
=== Parametry JSON ===
{| class="wikitable"
!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 ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|Obiekt profilu patrz: [https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|}

Wersja z 14:00, 27 mar 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
organization_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=186”