Создание Пользователя

Метод Create an User используется для создания пользователя. Запрос должен осуществляться с использованием API token.

POST /api/vendor/v1/users.json?api_token={}

Аргументы

Название

Тип параметров

Тип данных

Обязательный/Опциональный

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

first_name

form

string

Обязательный

Имя

middle_name

form

string

ОпциональныйОтчество
last_name

form

string

Обязательный

Фамилия
password

form

string

Обязательный

Пароль пользователя. Требования к паролю описаны в разделе Настройки пароля в ActivePlatform. Руководство по Панели управления Оператора
email

form

string

Обязательный

Адрес электронной почты
custom_attributes[][key]

form

string

Зависит от ID типа аккаутна

Дополнительные параметры позволяют добавлять в ActivePlatform дополнительную информацию (см.Настройка Дополнительных параметров в ActivePlatform. Руководство по Панели управления Оператора).

Ключ, который используется для обозначения элемента в API (см. Создание дополнительного параметра в ActivePlatform. Руководство по Панели управления Оператора)

custom_attributes[][value]

form

Depends on attributeЗависит от ID типа аккаутнаЗначение дополнительного параметра

Модель ответа

Название

Тип данных

Описание

id

integer

Уникальный идентификационный номер пользователя

first_name

string

Имя пользователя

middle_name

string

Отчество пользователя

last_name

string

Фамилия пользователя

email

string

Электронная почта пользователя, которая используется в качестве логина

status

string

Глобальный статус пользователя в ActivePlatform вне зависимости от статуса пользователя для конкретного клиента:

  • active - активный;

  • Inactive - неактивный.

custom_attributes

array

Дополнительные параметры пользователя (см. Настройка дополнительных параметров в ActivePlatform. Руководство по Панели управления Оператора):

  • name - имя параметра;

  • value - значение параметра.

created_at

date

Дата и время создания пользователя.

updated_at

date

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

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

POST http://billing.activeplatform.com:80/api/vendor/v1/users.json?api_token=654321
{
  "first_name": "John",
  "middle_name": "",
  "last_name": "Doe",
  "password": "N;T@o;y!4TNqlV",
  "email": "john.doe8@activeplatfrom.com",
  "custom_attributes": [
     {
       "key": "age",
       "value": "21"
     }
  ]
}

Пример ответа

При успешном создании Пользователя метод возвращает:

{
  "id": 2021053,
  "first_name": "John",
  "middle_name": "",
  "last_name": "Doe",
  "email": "john.doe8@activeplatfrom.com",
  "status": "active",
  "custom_attributes": [
    {
      "name": "Age",
      "value": "21"
    }
  ],
  "created_at": "2016-10-07T14:15:47.746+03:00",
  "updated_at": "2016-10-07T14:15:47.746+03:00"
}

При отсутствии необходимых данных метод возвращает соответствующую ошибку, например:

{
	"error": "password is missing"
}