Создание менеджера

Метод Create manager позволяет создать менеджера (сотрудника) для текущего реселлера или любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о Сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

Создание менеджера (сотрудника) доступно только сотрудникам с ролью Системный администратор (см. Роли Сотрудников).

POST {base_url}/api/v3/resellers/{reseller_id}/managers

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о Реселлере)
dataformobjectОбязательныйИнформация об атрибутах операции

attributesformobjectОбязательныйАтрибуты операции


nameformstringОбязательныйИмя сотрудника


emailformstringОбязательныйАдрес email сотрудника, который будет использоваться для входа в Панель управления Оператора


roleformstringОбязательныйРоль сотрудника в Панель управления Оператора (список ролей см. в Роли Сотрудников)


manager_role_idformintegerОпциональныйID уровня доступа менеджера (см. Управление уровнями доступа и Получение списка уровней доступа менеджеров). Не используется, если role = admin


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


phoneformstringОпциональный

Номер телефона сотрудника в международном формате:

  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


manager_keyformstringОпциональный
Уникальный ключ сотрудника

Ключ позволяет автоматически привязывать к Сотруднику Клиентов (см. Просмотр и обновление информации о Клиенте), воспользовавшихся специальной ссылкой при заказе новой Услуги через Витрину (см. manager_key в Шаблон ссылки для заказа Услуги через Витрину). Ключ может содержать латинские буквы, цифры, точки, дефисы и символы подчеркивания. Ключ Сотрудника чувствителен к регистру. Важно указывать в ссылке ключ так, как он указан на странице Сотрудника. Например, carter81 и Carter81 — это разные ключи, которые не будут работать вместе.



custom_attributesformobjectОпциональныйДополнительные параметры сотрудника (см. Настройка Дополнительных параметров)



dataformarrayОпциональныйИнформация о дополнительных параметрах сотрудника




keyformstringЗависит от параметраКлюч дополнительного параметра сотрудника




valueformstringЗависит от параметра

Значение дополнительного параметра сотрудника.

В зависимости от типа данных значение дополнительного параметра сотрудника указывается в следующем формате:

  • Логический тип:
    • 1 соответствует true.
    • 0 соответствует false.
  • Дата: ДД.ММ.ГГГГ.
  • Список: Ключ элемента.

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

В случае отсутствия ошибок метод возвращает данные о созданном менеджере (сотруднике) (см. модель ответа в Получение информации о менеджере Реселлера по 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",
            "role": "admin",
            "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",
            "role": "admin",
            "manager_role": {
                "id": null,
                "name": null
            },
            "phone": "+375290000000",
            "photo": null,
            "manager_key": "",
            "mfa_required": true,
            "custom_attributes": {
                "test": "1"
            }
        }
    }
}