API: Rejestracja (konta i profile): Różnice pomiędzy wersjami
Przejdź do nawigacji
Przejdź do wyszukiwania
Nie podano opisu zmian |
Nie podano opisu zmian |
||
| Linia 9: | Linia 9: | ||
!Opis | !Opis | ||
!Wymagane | !Wymagane | ||
!Walidacja | |||
|- | |- | ||
|name | |name | ||
|string | |string | ||
| | |Jan | ||
| | |Imię | ||
|Tak | |Tak | ||
|Długość: 50 | |||
|- | |- | ||
|phone | |phone | ||
|string | |string | ||
| | | +48 699 999 999 | ||
| | |Telefon | ||
| | |Tak | ||
|Cyfry, spacja i znak +; Długość: 20 | |||
|- | |- | ||
|email | |email | ||
|string | |string | ||
| | |jankowalski@domena.pl | ||
| | |E-mail | ||
| | |Tak | ||
|Adres email zgodny z RFC 5322 i RFC 6854 | |||
|- | |- | ||
|organization_id | |organization_id | ||
|integer | |integer | ||
| | |1 | ||
| | |Organizacja (Placówka POZ) | ||
| | |Tak | ||
|ID organizacji (lista w [[API: Zasoby publiczne i konfiguracje ogólne]]) | |||
|- | |- | ||
|agreements | |agreements | ||
|array | |array | ||
| | |[1:true,2:true,3:false] | ||
| | |Zgody prawne | ||
| | |Tak | ||
|Tablica z id zgody i wartością bool jej akceptacji (lista w [[API: Zasoby publiczne i konfiguracje ogólne]]) | |||
|- | |- | ||
|app_signature | |app_signature | ||
| Linia 45: | Linia 51: | ||
|Podpis aplikacji | |Podpis aplikacji | ||
|Tak | |Tak | ||
| | |||
|- | |- | ||
|app_version | |app_version | ||
| Linia 51: | Linia 58: | ||
|Wersja aplikacji | |Wersja aplikacji | ||
|Tak | |Tak | ||
| | |||
|} | |} | ||
| Linia 76: | Linia 84: | ||
|Tablica z błędami walidacji | |Tablica z błędami walidacji | ||
|- | |- | ||
| | |validation.name | ||
| | |string | ||
| | |too_long | ||
| | |"Wartość pola 'nazwa' zbyt długa | ||
|- | |- | ||
|user | |user | ||
Wersja z 10:54, 14 gru 2023
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 | Imię | Tak | Długość: 50 |
| phone | string | +48 699 999 999 | Telefon | Tak | Cyfry, spacja i znak +; Długość: 20 |
| string | jankowalski@domena.pl | Tak | Adres email zgodny z RFC 5322 i RFC 6854 | ||
| organization_id | integer | 1 | Organizacja (Placówka POZ) | Tak | ID organizacji (lista w API: Zasoby publiczne i konfiguracje ogólne) |
| agreements | array | [1:true,2:true,3:false] | Zgody prawne | Tak | Tablica z id zgody i wartością bool jej akceptacji (lista w API: Zasoby publiczne i konfiguracje ogólne) |
| app_signature | string | SDrRobSvWeb | Podpis aplikacji | Tak | |
| app_version | string | 1.0.1-20231121 | Wersja aplikacji | Tak |
Odpowiedź poprawna
Identyczna jak w API: Autoryzacja
Odpowiedź niepoprawna walidacja
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 |
|---|---|---|---|
| error | string | validation | Informacja o typie błędu, tutaj walidacja |
| validation | array | Tablica z błędami walidacji | |
| validation.name | string | too_long | "Wartość pola 'nazwa' zbyt długa |
| user | array | Tablica z danymi użytkownika | |
| user.name | string | Jan Testowy | Nazwa użytkownika |
| user.email | string | jankowalski@domena.pl | E-mail użytkownika |