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

Z DrRobert DOCS
Przejdź do nawigacji Przejdź do wyszukiwania
Nie podano opisu zmian
Nie podano opisu zmian
 
(Nie pokazano 6 pośrednich wersji utworzonych przez tego samego użytkownika)
Linia 15: Linia 15:
|Jan Kowalski
|Jan Kowalski
|Nazwa użytkownika: imię lub imię i nazwisko
|Nazwa użytkownika: imię lub imię i nazwisko
|Nie
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Tak
|Tak
|Długość: 50
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Tak
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|-
|-
|phone
|phone
Linia 39: Linia 60:
|Minimum 8 dowolnych znaków
|Minimum 8 dowolnych znaków
|-
|-
|organization_id
|organisation_id
|integer
|integer
|1
|1
Linia 102: Linia 123:
|Nazwa profilu: imię lub imię i nazwisko
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Tak
|Długość: 50
|Długość: 50; Gdy puste ale podane firstname i lastname to są one łączone do name
|-
|firstname
|string
|Jan
|Imię użytkownika
|Nie
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Nie
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|}
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]
Linia 115: Linia 157:
|user
|user
|UserObject
|UserObject
|[https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|[[API: UserObject]]
|Obiekt profilu patrz: [https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|Obiekt profilu patrz: [[API: UserObject]]
|}
|}

Aktualna wersja na dzień 08:34, 24 lut 2026

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 Nie Długość: 50
firstname string Jan Imię użytkownika Tak
lastname string Kowalski Nazwisko użytkownika Tak
pesel string 99062873619 PESEL użytkownika Nie czy prawidłowy pesel
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; Gdy puste ale podane firstname i lastname to są one łączone do name
firstname string Jan Imię użytkownika Nie
lastname string Kowalski Nazwisko użytkownika Nie
pesel string 99062873619 PESEL użytkownika Nie czy prawidłowy pesel

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