Создание менеджера
Метод Create manager позволяет создать менеджера (сотрудника) для текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
POST {base_url}/api/v3/resellers/{reseller_id}/managers
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | |||||
---|---|---|---|---|---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | |||||
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json | |||||
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json | |||||
base_url | path | string | Обязательный | URL ActivePlatform | |||||
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) | |||||
data | form | object | Обязательный | Информация об атрибутах операции | |||||
attributes | form | object | Обязательный | Атрибуты операции | |||||
name | form | string | Обязательный | Имя сотрудника | |||||
form | string | Обязательный | Адрес email сотрудника, который будет использоваться для входа в Панель управления Оператора | ||||||
admin | form | bool | Опциональный | Признак администратора:
| |||||
manager_role_id | form | integer | Опциональный | ID роли менеджера (см. Роли сотрудников и Получение списка ролей менеджеров). Игнорируется, если | |||||
password | form | string | Обязательный | Пароль сотрудника для входа в Панель управления Оператора. Требования к паролю см. в Настройки пароля | |||||
phone | form | string | Опциональный | Номер телефона сотрудника в международном формате:
| |||||
manager_key | form | string | Опциональный | Уникальный ключ сотрудника Ключ позволяет автоматически привязывать к менеджеру клиентов (см. Просмотр и обновление информации о клиенте), воспользовавшихся специальной ссылкой при заказе новой услуги через Витрину (см. manager_key в Шаблон ссылки для заказа услуги через Витрину). Ключ может содержать латинские буквы, цифры, точки, дефисы и символы подчеркивания. Ключ менеджера чувствителен к регистру. Важно указывать в ссылке ключ так, как он указан на странице менеджера. Например, carter81 и Carter81 — это разные ключи, они не будут работать вместе для одного менеджера. | |||||
custom_attributes | form | object | Опциональный | Дополнительные параметры сотрудника (см. Настройка дополнительных параметров) | |||||
data | form | array | Опциональный | Информация о дополнительных параметрах сотрудника | |||||
key | form | string | Зависит от параметра | Ключ дополнительного параметра сотрудника | |||||
value | form | string | Зависит от параметра | Значение дополнительного параметра сотрудника. В зависимости от типа данных значение дополнительного параметра сотрудника указывается в следующем формате:
|
Модель ответа
В случае отсутствия ошибок метод возвращает данные о созданном менеджере (сотруднике) (см. модель ответа в Получение информации о менеджере Реселлера по ID).
Ошибки валидации параметров менеджера (сотрудника) отображаются аналогично Панели управления Оператора (см. Создание сотрудника реселлера в ActivePlatform. Руководство по Панели управления Оператора (Реселлера)).
Пример запроса
POST /api/v3/resellers/1/managers
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
"data": {
"attributes": {
"name": "Angelica Johnson",
"email": "nigel65@example.org",
"admin": true,
"password": "qwerty",
"phone": "+375290000000",
"custom_attributes": {
"data": [
{
"key": "test",
"value": "1"
}
]
}
}
}
}
Пример ответа
{
"data": {
"id": "317",
"type": "managers",
"attributes": {
"created_at": "2020-12-09T08:17:47.773+03:00",
"updated_at": "2020-12-09T08:17:47.776+03:00",
"reseller_id": 1,
"name": "Angelica Johnson",
"status": "active",
"email": "nigel65@example.org",
"manager_role": {
"id": null,
"name": null
},
"phone": "+375290000000",
"photo": null,
"manager_key": "",
"mfa_required": true,
"custom_attributes": {
"test": "1"
}
}
}
}