-
Notifications
You must be signed in to change notification settings - Fork 1
Регистрация
Alien Ufo edited this page Mar 28, 2023
·
6 revisions
Регистрация нового пользователя в системе.
-
Для вызова метода необходимо предварительно получить разрешение на авторизацию учётные данные клиента.
-
Метод вызывается сервером авторизации при регистрации пользователя.
POST /api/v1/sign/up
Параметры:
Имя | Тип | Значение | Описание |
---|---|---|---|
type | STRING | entity, physical, individual | Рекомендуемый. Тип клиента. По умолчанию: physical. |
username | STRING | Обязательный. Логин пользователя. | |
password | STRING | Обязательный. Пароль пользователя. | |
name | JSON object | Рекомендуемый. Полное наименование компании/Ф.И.О. клиента (пользователя). | |
phone | STRING | Рекомендуемый. Телефон. | |
STRING | Рекомендуемый. Электронный адрес. | ||
profile | JSON | Необязательный. Дополнительная информация учётной записи пользователя. | |
description | STRING | Необязательный. Описание. |
Формат name
:
Ключ | Тип | Описание |
---|---|---|
name | STRING | Рекомендуемый. Полное наименование организации/Ф.И.О одной строкой |
short | STRING | Необязательный. Краткое наименование организации |
first | STRING | Рекомендуемый. Имя |
last | STRING | Рекомендуемый. Фамилия |
middle | STRING | Необязательный. Отчество |
Группы:
-
<name>
[<short>]
-
<first>
<last>
[<middle>]
[<short>]
Формат ключа profile
:
Ключ | Тип | Описание |
---|---|---|
locale | UUID | Необязательный. Идентификатор локализаций для установки по умолчанию. |
area | UUID | Необязательный. Идентификатор зоны (подразделения) для установки по умолчанию. |
interface | UUID | Необязательный. Идентификатор интерфейса для установки по умолчанию. |
email_verified | BOOLEAN | Необязательный. Электронный адрес подтверждён. |
phone_verified | BOOLEAN | Необязательный. Телефон подтверждён. |
picture | STRING | Необязательный. URL на логотип. |
Описание ответа:
Поле | Тип | Описание |
---|---|---|
id | UUID | Идентификатор созданного клиента. |
userid | UUID | Идентификатор учётной записи пользователя. |
uid | STRING | Username (login) пользователя. |
secret | STRING | Секретный код пользователя. |
Пример:
Запрос:
POST /api/v1/sign/up HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[сокращенно для краткости].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg
{"type": "physical", "name": {"name": "User Name", "short": "UserName", "first": "User", "last": "Name"}, "phone": "79001234567", "email": "[email protected]", "profile": {"locale": "00000000-0000-4001-a000-000000000002", "phone_verified": true}}
Ответ (положительный):
{"id":"12538dba-da65-40a2-8cbb-466813579b44","userid":"c12c2490-b79e-4758-a317-0b26b18688dd","uid":"demo","secret":"3d91...3ed3"}
Ответ (отрицательный):
{"error": {"code": 400, "message": "Учётная запись с электронным адресом \"[email protected]\" уже зарегистрирована."}}