Группа методов Account внешнего программного интерфейса Менеджера сервиса предназначена для управления свойствами абонентов и управления пользователями абонентов.
Также к группе методов Account относятся методы для управления обслуживаемыми абонентами (для обслуживающей организации)
Сводка по методам
Метод | Примечание |
---|---|
root | |
list | Возвращает список абонентов, доступных пользователю. |
info | Возвращает информацию об указанном абоненте. |
servant_info | Возвращает информацию об обслуживающей организации абонента. Метод устарел. Следует использовать метод servants/list. |
update_info | Обновляет информацию указанного абонента. |
attached_info | Возвращает дополнительную информацию абонента (реквизиты и свойства). |
update_attached_info | Обновляет дополнительную информацию абонента (реквизиты и свойства). |
users | |
list | Возвращает список пользователей абонента. |
info | Возвращает информацию об указанном пользователе абонента. |
add | Добавляет существующего пользователя к абоненту. |
create | Создает нового пользователя сервиса и прикрепляет к абоненту. |
delete | Удаляет существующего пользователя абонента (пользователь сервиса не удаляется). |
set_role | Устанавливает роль пользователю абонента. |
set_session_restriction | Устанавливает ограничение по сеансам для пользователя абонента. |
update_attached_info | Обновляет дополнительные реквизиты пользователя абонента. |
servants | |
list | Возвращает список обслуживающих организаций абонента. |
tariff_selection_page | Возвращает страницу выбора тарифа обслуживающей организации в соответствии с текущей витриной. |
servant_tariffs | |
info | Получение информации о тарифе обслуживающей организации. |
list | Получение списка тарифов обслуживающих организаций. |
account/list
Метод возвращает список абонентов, доступных пользователю, от имени которого выполняется вызов метода.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
нет параметров | ||
Ответ: account (0..*) | ||
id | Число | Код абонента. |
name | Строка | Наименование. |
role | Строка | Роль пользователя (перечисление). |
POST {{server}}/{{url}} Authorization: {{authorization}} { "general":{ "type":"ext", "method":"account/list" } }
Для метода доступен GET-запрос, например:
GET https://{{server}}/a/adm/hs/ext_api/execute/usr/account/list Authorization: {{authorization}}
Возможные значения поля role указаны в описании метода Account — свойства абонента и управление пользователями абонента#account/users/set_role .
account/info
Метод возвращает информацию об указанном абоненте. Поиск абонента выполняется по коду.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента. |
Ответ: account (1) | ||
id | Число | Код абонента. |
name | Строка | Наименование. |
site | Строка | Сайт из "Контактной информации". |
city | Строка | Город из "Контактной информации". |
Строка | Почта из "Контактной информации". | |
phone | Строка | Почта из "Контактной информации". |
POST {{server}}/{{url}} Authorization: {{authorization}} { "general":{ "type":"ext", "method":"account/info" }, "auth": { "account":{{account}} }, "id": {{account}} }
account/update_info
Метод обновляет свойства указанного абонента указанными значениями.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента. |
name | Строка | Наименование. |
site | Строка | Сайт из "Контактной информации". |
city | Строка | Город из "Контактной информации". |
Строка | Почта из "Контактной информации". | |
phone | Строка | Телефон из "Контактной информации". |
Ответ (1) | ||
нет параметров |
account/servant_info
Метод возвращает информацию и контактные данные абонента, который является обслуживающей организацией для указанного абонента.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код обслуживаемого абонента. |
Ответ: servant (1) | ||
id | Число | Код обслуживающего абонента. |
name | Строка | Наименование. |
site | Строка | Сайт из "Контактной информации". |
city | Строка | Город из "Контактной информации". |
Строка | Почта из "Контактной информации". | |
phone | Строка | Почта из "Контактной информации". |
account/attached_info
Метод возвращает значения дополнительных реквизитов и дополнительных свойств, установленные для указанного абонента.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента |
Ответ (1) | ||
fields *+ | Массив | Дополнительные реквизиты абонента. Ключи:
|
properties *+ | Массив | Дополнительные свойства абонента. Ключи:
|
POST {{server}}/{{url}} Authorization: {{authorization}} { "general":{ "type":"ext", "method":"account/attached_info" }, "auth": { "account":{{account}} }, "id": {{account}} }
account/update_attached_info
Метод обновляет значения дополнительных реквизитов и дополнительных свойств указанного абонента.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента |
fields | Массив | Дополнительные реквизиты абонента. Массив структур вида
|
properties | Массив | Дополнительные свойства абонента. Массив структур вида
|
Ответ (1) | ||
нет параметров |
Если в массивах будут указаны названия дополнительных реквизитов и свойств, которые не настроены в информационной базе "Менеджер сервиса", будет возвращена ошибка ("error": true) c кодом возврата 10406. В параметре ответа message будет указано, какие свойства или реквизиты не найдены, например Свойство 'ИНН' не найдено.".
Если в массивах будут указаны не все дополнительные реквизиты и свойства, настроенные в информационной базе "Менеджер сервиса" для справочника "Абоненты", а для указанного абонента ранее были записаны значения этих недостающих реквизитов и свойств, ранее записанные значения недостающих реквизитов и свойств останутся без изменений.
account/users/list
Метод возвращает список пользователей, подключенных к указанному абоненту.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента. |
Ответ: user (1) | ||
login | Строка | Логин пользователя. |
name | Строка | Полное имя пользователя |
Строка | Адрес электронной почты пользователя. | |
role | Строка | Роль пользователя в приложении (перечисление). |
session_restriction | Число | Ограничение по количеству сеансов. |
is_temporary | Булево | Указывает, что пользователь имеет только временный доступ. |
POST {{server}}/{{url}} Authorization: {{authorization}} { "general":{ "type":"ext", "method":"account/users/list" }, "auth": { "account":{{account}} }, "id": {{account}} }
Возможные значения поля role указаны в описании метода Account — свойства абонента и управление пользователями абонента#account/users/set_role .
account/users/info
Метод возвращает текущие значения свойств указанного пользователя, подключенного к указанному абоненту.
Поле | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1 010 |
login | Строка переменная (32) | Логин пользователя | Abramov |
Ответ: user (1) | |||
login | Строка переменная (32) | Логин пользователя | Abramov |
is_temporary | Булево | Временный доступ | false |
session_restriction * | Число (+10.0) | Разрешенное количество сеансов | 5 |
email * | Строка переменная (254) | Адрес электронной почты | abramov@example.com |
name | Строка переменная (150) | Полное имя пользователя | Абрамов Геннадий Сергеевич |
role * | Строка неограниченной длины | Роль пользователя абонента | owner |
description * | Строка переменная (300) | Описание пользователя абонента | Использует БП и ЗУП |
fields | Список (0..*) | Дополнительные реквизиты | |
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type * | Строка неограниченной длины | Тип реквизита | boolean |
Возможные значения поля role указаны в описании метода Account — свойства абонента и управление пользователями абонента#account/users/set_role .
account/users/add
Метод подключает пользователя с указанным логином к указанному абоненту. Выполнение метода аналогично действиям, которые выполняет мастер создания нового пользователя (команды "Управление пользователями - Добавить") в интерфейсе Личного кабинета в режиме "Добавить существующего пользователя сервиса". В поле fields могут указываться дополнительные реквизиты.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1 010 |
role * | Строка неограниченной длины | Роль пользователя абонента | owner |
login | Строка переменная (32) | Логин пользователя | Larionova |
description * | Строка переменная (300) | Описание пользователя абонента | Использует БП и ЗУП |
force * | Булево | Выполнить даже при наличии предупреждений | Нет |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type * | Строка неограниченной длины | Тип реквизита | boolean |
Ответ (1) | |||
нет параметров |
Возможные значения поля role указаны в описании метода Account — свойства абонента и управление пользователями абонента#account/users/set_role .
account/users/create
Метод создает новую учетную запись пользователя сервиса и подключает созданного пользователя к указанному абоненту. Выполнение метода аналогично действиям, которые выполняет мастер создания нового пользователя (команды "Управление пользователями - Добавить") в интерфейсе Личного кабинета в режиме "Создать нового пользователя". В поле fields могут указываться дополнительные реквизиты.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1 010 |
role * | Строка неограниченной длины | Роль пользователя абонента | owner |
login | Строка переменная (32) | Логин пользователя | Nestor |
password * | Строка неограниченной длины | Пароль пользователя | w13p-3q |
email * | Строка переменная (254) | Адрес электронной почты | nestor@example.com |
email_required * | Булево | Указан адрес электронной почты | false |
name | Строка переменная (150) | Полное имя пользователя | Иващенко Нестор Иванович |
phone * | Строка переменная (500) | Телефон пользователя | +7 (495) 231-54-76 |
timezone * | Строка переменная (100) | Часовой пояс пользователя | Europe/Moscow |
description * | Строка переменная (300) | Описание пользователя абонента | Использует БП и ЗУП |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type * | Строка неограниченной длины | Тип реквизита | boolean |
Ответ | |||
нет параметров |
Возможные значения поля role указаны в описании метода Account — свойства абонента и управление пользователями абонента#account/users/set_role .
account/users/delete
Метод отключает указанного пользователя от указанного абонента. Выполнение метода равнозначно выполнению команд "Управление пользователями - Удалить" в интерфейсе Личного кабинета.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента. |
login | Строка | Логин пользователя. |
Ответ (1) | ||
нет параметров |
POST {{server}}/{{url}} Authorization: {{authorization}} { "general":{ "type":"ext", "method":"account/users/delete" }, "auth": { "account":{{account}} }, "id": {{account}}, "login": "{{user_login}}" }
account/users/set_role
Метод устанавливает указанному пользователю указанного абонента указанную роль.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента. |
login | Строка | Логин пользователя. |
role | Строка | Роль нового в приложении (перечисление). |
Ответ (1) | ||
нет параметров |
Возможные значения поля role:
- owner — Владелец абонента (управление абонентом).
- administrator — Администратор абонента (управление пользователями абонента).
- ext_administrator — Администратор средств адаптации
- operator — Оператор обслуживающей организации.
- user — Пользователь абонента (запуск приложений).
POST {{server}}/{{url}} Authorization: {{authorization}} { "general":{ "type":"ext", "method":"account/users/set_role" }, "auth": { "account":{{account}} }, "id": {{account}}, "login": "{{user_login}}", "role": "owner" }
account/users/set_session_restriction
Метод устанавливает для указанного пользователя указанного абонента указанное ограничение на количество одновременных сеансов работы с приложениями. Значение "0" означает "без ограничений".
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
id | Число | Код абонента. |
login | Строка | Логин пользователя. |
restriction *+ | Число | Количество сеансов, разрешенных пользователю (ноль означает "любое количество"). |
Ответ (1) | ||
нет параметров |
account/users/update_attached_info
Метод обновляет дополнительные реквизиты пользователя абонента.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1 010 |
login | Строка переменная (32) | Логин пользователя | Abramov |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type * | Строка неограниченной длины | Тип реквизита | boolean |
Ответ (1) | |||
Нет параметров |
account/servants/list
Получение списка обслуживающих организаций абонента
Параметр | Тип | Примечание | Пример |
---|---|---|---|
Запрос | |||
id | Число | Код абонента | 1010 |
Ответ: servants (0..*) | |||
name * | Строка | Наименование | Помощник 1С |
id | Число | Код абонента | 1000 |
servant_id * | Строка | Значение реквизита абонента Идентификатор | 00000 |
city * | Строка | Город из "Контактной информации". | Москва |
site * | Строка | Сайт из "Контактной информации". | www.example.com |
email * | Строка | Город из "Контактной информации". | info@example.com |
phone * | Строка | Телефон из "Контактной информации". | +7 (495) 765-43-21 |
tariff_subscribe_allowed * | Булево | Обслуживающей организации разрешено подписывать на тарифы | true |
automatic_billing_allowed * | Булево | Обслуживающей организации разрешено автоматическое выставление счетов | false |
tariff_override_allowed * | Булево | Обслуживающей организации разрешено переопределение тарифов провайдера | false |
tariff_selection_page_only * | Булево | Отображать только собственную страницу выбора тарифов | false |
account/servants/tariff_selection_page
Возвращает страницу выбора тарифа обслуживающей организации в соответствии с текущей витриной.
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
servant | Число | Код абонента обслуживающей организации |
account | Число | Код абонента обслуживающей организации |
Ответ: html (0..1) | ||
html | Строка | HTML-код страницы выбора тарифа обслуживающей организации |
POST {{server}}/{{url}} Authorization: Basic {{auth}} { "auth": { "account": {{account}} }, "general": { "type": "usr", "method": "account/servants/tariff_selection_page" }, "servant": {{account}} }
{ "html": "<!DOCTYPE html><html lang=\"ru\"><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"></meta><style type=\"text/css\">\n body {font-family: Arial, Helvetica, sans-serif; font-size: 10pt;}\n pre {background-color: lightgrey; margin-top: 5px; margin-bottom: 5px; padding: 5px;} \n ul {margin-top: 2px; margin-bottom: 5px;}\n </style></head><body>\nВыберите подходящий тариф и период:\n<ul><li><a data-tariff=\"1\" data-period=\"3MN\" href=\"#\">Купить тариф ПРОФ на 3 месяца за 15000 руб.</a></li>\n<li><a data-tariff=\"1\" data-period=\"6MN\" href=\"#\">Купить тариф ПРОФ на 6 месяцев за 27000 руб.</a></li>\n<li><a data-tariff=\"1\" data-period=\"12MN\" href=\"#\">Купить тариф ПРОФ на 12 месяцев за 48000 руб.</a></li>\n</ul></body></html>", "general": { "response": 10200, "error": false, "message": "", "version": 6, "sm_version": "1.0.82.30", "sm_timezone": "Europe/Moscow" } }
account/servant_tariffs/info
Получение информации о тарифе обслуживающей организации
Параметр | Тип | Примечание |
---|---|---|
Запрос | ||
servant | Число | Код обслуживающей организации |
id | Число | Код тарифа обслуживающей организации |
Ответ: servant_tariff (1) | ||
id | Строка | Код тарифа обслуживающей организации |
name | Строка | Наименование тарифа обслуживающей организации |
tariff_id | Строка | Код базового тарифа провайдера |
description_for_subscribers | ||
- html | Строка | Описание для абонентов |
- images | Массив | Картинки описания |
- - name | Строка | Имя картинки |
- - data | Строка | Данные картинки в формате base64 |
validity_periods | Массив | Периоды действия тарифа |
- id | Строка | Код периода действия |
- name | Строка | Код периода действия |
- period | Строка | Тип периода действия |
- quantity | Число | Количество периодов |
- cost | Число | Стоимость |
- comment | Строка | Комментарий |
POST {{server}}/{{url}} Authorization: Basic {{auth}} { "auth": { "account": {{account}} }, "general": { "type": "usr", "method": "account/servant_tariffs/info" }, "servant": {{account}}, "id": {{id}} }
{ "servant_tariff": { "id": "099", "name": "Партнерский ПРОФ", "tariff_id": "099", "description_for_subscribers": { "html": "<html>\n<head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n<meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\" />\n<meta name=\"format-detection\" content=\"telephone=no\" />\n<style type=\"text/css\">\nbody{margin:0;padding:8px;}\np{line-height:1.15;margin:0;white-space:pre-wrap;}\nol,ul{margin-top:0;margin-bottom:0;}\nimg{border:none;}\nli>p{display:inline;}\n</style>\n</head>\n<body>\n<p><iframe url="https://ya.ru" width="100%" height="600"></frame><img height=\"44\" src=\"image001\" style=\"border:none;\" width=\"30\"/></p>\n</body>\n</html>", "images": [ { "name": "image001", "data": "iVBORw0KGgoAAAANSUhEUgAAAB4AAAAsCAAAAABX6VfYAAAAI0lEQVR4AWP4jxeM\r\nSgOBNBgQIz0qLY0TDGJpiv09Ko0Ao9IAo4QtRdzqXu8AAAAASUVORK5CYII=" } ] }, "validity_periods": [ { "quantity": 2, "id": "2MN", "name": "2 месяца", "cost": 8040, "comment": "", "period": "month" }, { "quantity": 6, "id": "6MN", "name": "6 месяцев", "cost": 23000, "comment": "", "period": "month" }, { "quantity": 12, "id": "12MN", "name": "12 месяцев", "cost": 44000, "comment": "", "period": "month" }, { "quantity": 3, "id": "3MN", "name": "3 месяца", "cost": 11999, "comment": "", "period": "month" } ] }, "general": { "response": 10200, "error": false, "message": "", "version": 6, "sm_version": "1.0.82.31", "sm_timezone": "Europe/Moscow" } }
account/servant_tariffs/list
Получение списка тарифов обслуживающей организации
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код обслуживающей организации | 1000 |
scope * | Массив из Строка переменная (255) | Параметры получения данных:
| ["validity_periods"] |
available_tariffs * | Массив из Строка переменная (9) | Отбор доступных тарифов расширений | ["000000002", "000000003"] |
Ответ: servant_tariff (0..*) | |||
id | Строка переменная (9) | Код тарифа обслуживающей организации | 000000021 |
name | Строка переменная (150) | Наименование тарифа обслуживающей организации | Пример тарифа обслуживающей организации |
tariff_id | Строка переменная (9) | Код базового тарифа провайдера | 000000001 |
brief_description * | Строка переменная (1024) | Краткое описание | Краткое описание тарифа |
validity_periods | Список (0..*) | Периоды действия тарифа | |
- id | Строка переменная (10) | Код периода | 1YR |
- name | Строка переменная (50) | Наименование периода | 1 год |
- quantity | Число (+10.0) | Количество периодов | 1 |
- cost * | Число (+10.2) | Стоимость | 1500 |
- comment * | Строка переменная (1024) | Комментарий | Комментарий периода действия |
- period | Строка неограниченной длины | Тип периода действия | year |
- recommended * | Булево | Рекомендуемый | false |