Метод: Регистрация нового пользователя на платформе promotivation

Метод служит для регистрации нового пользователя на платформе promotivation.

URL

 POST {домен}/api/v2/user/add

Описание

Метод служит для регистрации нового пользователя на платформе promotivation.

Структура запроса

Пример запроса

Формат запроса:

POST {домен}/api/v2/user/add

"Authorization: Bearer 1jijdsaohdiadibbcsanco……"
"Content-Type: application/json"

{
  "idExternal": "dkfsa124ksad",
  "surname": "Иванов",
  "name": "Иван",
  "patronymic": "Иванович",
  "birthday": "01.01.2001",
  "phone": "9139134466",
  "mail": "mail@mail.ru",
  "innCompany": "1234567890",
  "sendNotification": "sms"
}

Параметры запроса

Параметр	Тип	Описание	Обязательный	Шифрование
`Authorization`	string	Уникальный токен аутентификации	Да	Нет
`idExternal`	string	Внешний идентификатор пользователя. До 30 символов.	Нет	Да
`surname`	string	Фамилия пользователя. До 30 символов.	Да	Да
`name`	string	Имя пользователя. До 30 символов.	Да	Да
`patronymic`	string	Отчество пользователя. До 30 символов.	Нет	Да
`birthday`	string	Дата рождения пользователя. До 10 символов.В формате ДД.ММ.ГГГГ.	Нет	Да
`phone`	int	Телефон пользователя. До 10 символов. Начиная с 9 (без кода страны)	Да	Да
`mail`	string	E-mail пользователя. До 30 символов. Уникальное значение в рамках Партнера.	Да	Да
`innCompany`	string	Инн компании сотрудника. От 10 до 12 символов, только цифры.	Нет	Да
`sendNotification`	string	sms или email. Средство связи, через которое будет отправлено уведомление об авторизации	Нет	Да

Если в запросе не поступил внешний идентификатор, будет сформирован системой promotivation.ru и отдан в ответе. Внешний идентификатор может состоять из латинских букв, цифр и коротких тире «-», длина до 36 символов. Должен быть уникальным значением.

Структура ответа

Пример успешного ответа

{
  "status": "OK",
  "idExternal": "dkfsa124ksad"
}

Параметры успешного ответа

Параметр	Тип	Описание
`status`	string	Статус
`idExternal`	string	Внешний идентификатор пользователя (если рне был передан)

Пример ответа с ошибкой

{
  "status": "INVALID_FIELDS",
  "message: " The fields are uncorrected quantity, offset ".
}

Параметры ответа с ошибками

Параметр	Тип	Описание
`status`	string	Статус ошибки
`message`	string	Информационное сообщение

Возможные ошибки

Статус	Описание
`INVALID_FIELDS`	Некорректное поле. Поле не соответствует требованиям.
`USER_NOT_FOUND`	Пользователь не найден
`TOKEN_ERROR`	Токен не найден