Получение информации о менеджере
Метод Get manager позволяет получить информацию о менеджере (сотруднике) по его ID для текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id}Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
|---|---|---|---|---|
| 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 любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) |
| manager_id | path | integer | Обязательный | ID сотрудника |
Модель ответа
Название | Тип данных | Описание | |||
|---|---|---|---|---|---|
| data | object | Данные ответа | |||
id | integer | ID сотрудника | |||
| type | string | Тип данных | |||
| attributes | object | Информация о сотруднике | |||
created_at | string | Дата и время создания сотрудника | |||
updated_at | string | Дата последнего обновления информации о сотруднике | |||
| reseller_id | integer | ID реселлера, к которому относится сотрудник | |||
| name | string | Имя сотрудника | |||
| status | string | Статус сотрудника:
| |||
| string | Адрес email сотрудника, который используется для входа в Панель управления Оператора | ||||
| manager_role | object | Роль сотрудника в Панель управления Оператора (список ролей см. в Роли сотрудников и Получение списка ролей менеджеров) | |||
| id | integer | ID роли. Для администратора на корневом уровне возвращает null | |||
| name | string | Название роли. Для администратора на корневом уровне возвращает null | |||
| phone | string | Номер телефона сотрудника в международном формате:
| |||
| photo | string | Ссылка на файл фотографии сотрудника | |||
| manager_key | string | Уникальный ключ сотрудника Ключ позволяет автоматически привязывать к менеджеру клиентов (см. Просмотр и обновление информации о клиенте), воспользовавшихся специальной ссылкой при заказе новой услуги через Витрину (см. manager_key в Шаблон ссылки для заказа услуги через Витрину). Ключ может содержать латинские буквы, цифры, точки, дефисы и символы подчеркивания. Ключ менеджера чувствителен к регистру. Важно указывать в ссылке ключ так, как он указан на странице менеджера. Например, carter81 и Carter81 — это разные ключи, они не будут работать вместе для одного менеджера. | |||
| mfa_required | bool | Статус многофакторной аутентификации (MFA) менеджера (см. Просмотр и обновление информации о сотруднике):
| |||
| custom_attributes | object | Дополнительные параметры сотрудника (см. Просмотр списка дополнительных параметров) | |||
| ['custom_attribute_key'] | string | Значение дополнительного параметра сотрудника с указанным ключом | |||
Пример запроса
GET /api/v3/resellers/1/managers/431
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonПример ответа
{
"data": {
"id": "431",
"type": "managers",
"attributes": {
"created_at": "2021-01-05T05:28:48.804+03:00",
"updated_at": "2021-01-05T06:23:10.815+03:00",
"reseller_id": 1,
"name": "Brendon Leannon",
"status": "active",
"email": "carter81@example.net",
"manager_role": {
"id": null,
"name": null
},
"phone": "+375290000000",
"photo": "/images/manager/431/manager.png",
"manager_key": "",
"mfa_required": true,
"custom_attributes": {
"manager_1c_identifier": "20"
}
}
}
}