Группа методов Account внешнего программного интерфейса Менеджера сервиса предназначена для управления свойствами абонентов и управления пользователями абонентов.
Также к группе методов Account относятся методы для управления обслуживаемыми абонентами (для обслуживающей организации)
Сводка по методам
Метод | Назначение |
---|---|
account/attached_info | Значения дополнительных реквизитов и сведений абонента |
account/info | Информация об абоненте |
account/list | Список абонентов |
account/update_info | Изменить свойства абонента |
account/servant_tariffs/info | Информация о тарифе обслуживающей организации |
account/servant_tariffs/list | Список тарифов обслуживающей организации |
account/servants/list | Cписок обслуживающих организаций |
account/servants/recommended_tariffs | Список рекомендуемых тарифов |
account/servants/tariff_selection_page | Страница выбора тарифа обслуживающей организации |
account/users/add | Подключить пользователя к абоненту |
account/users/available_attached_info | Список доступных дополнительных реквизитов пользователя абонента. |
account/users/create | Создать учетную запись и подключить нового пользователя к абоненту |
account/users/delete | Отключить пользователя сервиса от абонента |
account/users/info | Информация о пользователе абонента |
account/users/list | Список пользователей абонента |
account/users/set_role | Установить роль пользователя абонента |
account/users/set_session_restriction | Ограничить количество сеансов пользователя абонента |
account/users/update_attached_info | Обновляет дополнительные реквизиты пользователя абонента |
account/users/tenant/list | Список приложений, доступных пользователю абонента. |
account/attached_info
Значения дополнительных реквизитов и сведений абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
Ответ | |||
public_id * | Строка переменная (36) | Публичный идентификатор | 7713754211 |
properties | Список (0..*) | Дополнительные сведения | |
- key | Строка переменная (100) | Имя свойства | Тариф |
- name * | Строка переменная (75) | Заголовок свойства | Тариф |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение свойства | Базовый |
- type | Строка (перечисление) | Тип свойства:
| additional_value |
fields | Список (0..*) | Дополнительные реквизиты | |
- key | Строка переменная (100) | Имя реквизита | ИНН |
- name * | Строка переменная (75) | Заголовок реквизита | ИНН |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | 7799555550 |
- type | Строка (перечисление) | Тип реквизита:
| string |
account/info
Информация об абоненте
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
Ответ: account (1) | |||
name * | Строка переменная (64) | Наименование абонента | Конфетпром |
id | Число (+12.0) | Код абонента | 1010 |
city * | Строка переменная (500) | Город | Москва |
site * | Строка переменная (500) | Сайт | www.example.com |
email * | Строка переменная (500) | Почта | abramov@example.com |
phone * | Строка переменная (500) | Телефон | +7 (495) 123-45-67 |
site_id * | Число (+9.0) | Идентификатор сайта | 123 |
invitation_id * | Строка переменная (9) | Номер приглашения для регистрации | 000000123 |
account/list
Список абонентов
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
name * | Строка переменная (64) | Фильтр по наименованию абонента | конф |
Ответ: account (0..*) | |||
name | Строка переменная (64) | Наименование абонента | Конфетпром |
id | Число (+12.0) | Код абонента | 1010 |
role | Строка (перечисление) | Роль пользователя абонента:
| owner |
account/update_info
Изменить свойства абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
name | Строка переменная (64) | Наименование абонента | Конфетпром |
id | Число (+12.0) | Код абонента | 1010 |
city * | Строка переменная (500) | Город | Москва |
site * | Строка переменная (500) | Сайт | www.example.com |
email * | Строка переменная (500) | Почта | abramov@example.com |
phone * | Строка переменная (500) | Телефон | +7 (495) 123-45-67 |
site_id * | Число (+9.0) | Идентификатор сайта | 123 |
invitation_id * | Строка переменная (9) | Номер приглашения для регистрации | 000000123 |
Ответ: account (0..*) | |||
Нет параметров |
account/servant_tariffs/info
Информация о тарифе обслуживающей организации
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код обслуживающей организации | 1000 |
id | Строка переменная (9) | Код тарифа обслуживающей организации | 000000021 |
Ответ: servant_tariff (1) | |||
id | Строка переменная (9) | Код тарифа обслуживающей организации | 000000021 |
name | Строка переменная (150) | Наименование тарифа обслуживающей организации | Пример тарифа обслуживающей организации |
tariff_id | Строка переменная (9) | Код базового тарифа провайдера | 000000001 |
brief_description * | Строка переменная (1024) | Краткое описание | Краткое описание тарифа |
description_for_subscribers * | Информация для абонентов | ||
- html * | Строка неограниченной длины | HTML-код описания для абонентов | <html><body><img src="image001?_=1733500633"/><p>Пример описания тарифа</p></body></html> |
- images | Список (0..*) | Картинки описания | |
- images.name | Строка переменная (255) | Имя картинки | image001 |
- images.data | Двоичные данные размером до 1048576 байт в строке Base64 | Данные картинки, размер до 1 Мб | 89 50 4E 47 0D 0A 1A 0A 00 00 00 0D 49 48 44 52 00 00 00 10 00 00 00 10 08 06 00 00 00 1F F3 FF 61 0... |
validity_periods | Список (0..*) | Периоды действия тарифа | |
- id | Строка переменная (10) | Код периода | 1YR |
- name | Строка переменная (50) | Наименование периода | 1 год |
- quantity | Число (+10.0) | Количество периодов | 1 |
- cost * | Число (+10.2) | Стоимость | 1500 |
- comment * | Строка переменная (1024) | Комментарий | Комментарий периода действия |
- period | Строка (перечисление) | Тип периода действия:
| year |
- recommended * | Булево | Рекомендуемый | false |
account/servant_tariffs/list
Список тарифов обслуживающей организации
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код обслуживающей организации | 1000 |
scope * | Массив из Строка (перечисление) | Параметры получения данных:
| ["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 |
account/servants/list
Cписок обслуживающих организаций
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
Ответ: servants (0..*) | |||
name * | Строка переменная (64) | Наименование абонента | Помощник 1С |
id | Число (+12.0) | Код абонента | 1000 |
servant_id * | Строка переменная (50) | Идентификатор | 00000 |
city * | Строка переменная (500) | Город | Москва |
site * | Строка переменная (500) | Сайт | www.example.com |
email * | Строка переменная (500) | Почта | info@example.com |
phone * | Строка переменная (500) | Телефон | +7 (495) 765-43-21 |
site_id * | Число (+9.0) | Идентификатор сайта | 123 |
invitation_id * | Строка переменная (9) | Номер приглашения для регистрации | 000000123 |
tariff_subscribe_allowed * | Булево | Разрешено подписывать на тарифы | true |
automatic_billing_allowed * | Булево | Разрешено автоматическое выставление счетов | false |
tariff_override_allowed * | Булево | Разрешено переопределение тарифов провайдера | false |
tariff_selection_page_only * | Булево | Отображать только собственную страницу выбора тарифов | false |
account/servants/recommended_tariffs
Список рекомендуемых тарифов
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код обслуживающей организации | 1000 |
Ответ: recommended_tariffs (0..*) | |||
provider_tariff_id | Строка переменная (9) | Код тарифа провайдера | 000000001 |
servant_tariff_id * | Строка переменная (9) | Код тарифа обслуживающей организации | 000000001 |
account/servants/tariff_selection_page
Страница выбора тарифа обслуживающей организации
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код обслуживающей организации | 1000 |
Ответ: html (1) | |||
Нет параметров |
account/users/add
Подключить пользователя к абоненту
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
role * | Строка (перечисление) | Роль пользователя абонента:
| owner |
login | Строка переменная (50) | Логин пользователя | Larionova |
description * | Строка переменная (300) | Описание пользователя абонента | Описание текущего пользователя абонента |
force * | Булево | Выполнить даже при наличии предупреждений | false |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- name * | Строка переменная (75) | Заголовок реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type | Строка (перечисление) | Тип реквизита:
| boolean |
tenants * | Права на приложения. | ||
- id | Число (+7.0) | Номер приложения | 2000 |
- role * | Строка (перечисление) | Роль пользователя абонента:
| administrator |
Ответ: html (1) | |||
Нет параметров |
account/users/available_attached_info
Список доступных дополнительных реквизитов пользователя абонента.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
Ответ: fields (0..*) | |||
key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
name * | Строка переменная (75) | Заголовок реквизита | Внешний пользователь |
type | Строка (перечисление) | Тип реквизита:
| boolean |
account/users/create
Создать учетную запись и подключить нового пользователя к абоненту
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
role * | Строка (перечисление) | Роль пользователя абонента:
| owner |
login | Строка переменная (50) | Логин пользователя | 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) | Описание пользователя абонента | Описание пользователя абонента |
invite * | Булево | Пригласить пользователя. Если Истина, то не активируется приглашение для регистрации. | false |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- name * | Строка переменная (75) | Заголовок реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type | Строка (перечисление) | Тип реквизита:
| boolean |
tenants * | Права на приложения. | ||
- id | Число (+7.0) | Номер приложения | 2000 |
- role * | Строка (перечисление) | Роль пользователя абонента:
| administrator |
Ответ: fields (0..*) | |||
Нет параметров |
account/users/delete
Отключить пользователя сервиса от абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
login | Строка переменная (50) | Логин пользователя | Abramov |
Ответ: fields (0..*) | |||
Нет параметров |
account/users/info
Информация о пользователе абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
login | Строка переменная (50) | Логин пользователя | Abramov |
Ответ: user (1) | |||
login | Строка переменная (50) | Логин пользователя | Abramov |
is_temporary | Булево | Временный доступ | false |
session_restriction * | Число (+10.0) | Разрешенное количество сеансов | 5 |
description * | Строка переменная (300) | Описание пользователя абонента | Описание текущего пользователя абонента |
email * | Строка переменная (254) | Адрес электронной почты | abramov@example.com |
phone * | Строка переменная (500) | Телефон пользователя | +7 (495) 123-45-67 |
name | Строка переменная (150) | Полное имя пользователя | Абрамов Геннадий Сергеевич |
role * | Строка (перечисление) | Роль пользователя абонента:
| owner |
fields | Список (0..*) | Дополнительные реквизиты | |
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- name * | Строка переменная (75) | Заголовок реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type | Строка (перечисление) | Тип реквизита:
| boolean |
account/users/list
Список пользователей абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
name * | Строка переменная (150) | Фильтр по имени пользователя | Геннадий |
Ответ: user (0..*) | |||
login | Строка переменная (50) | Логин пользователя | Abramov |
is_temporary | Булево | Временный доступ | false |
session_restriction * | Число (+10.0) | Разрешенное количество сеансов | 5 |
email * | Строка переменная (254) | Адрес электронной почты | abramov@example.com |
name | Строка переменная (150) | Полное имя пользователя | Абрамов Геннадий Сергеевич |
description * | Строка переменная (300) | Описание пользователя абонента | Описание текущего пользователя абонента |
role * | Строка (перечисление) | Роль пользователя абонента:
| owner |
account/users/set_role
Установить роль пользователя абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
login | Строка переменная (50) | Логин пользователя | Abramov |
role | Строка (перечисление) | Роль пользователя абонента:
| owner |
Ответ: user (0..*) | |||
Нет параметров |
account/users/set_session_restriction
Ограничить количество сеансов пользователя абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
login | Строка переменная (50) | Логин пользователя | Abramov |
restriction | Число (+10.0) | Разрешенное количество сеансов | 5 |
Ответ: user (0..*) | |||
Нет параметров |
account/users/update_attached_info
Обновляет дополнительные реквизиты пользователя абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
login | Строка переменная (50) | Логин пользователя | Abramov |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ВнешнийПользователь |
- name * | Строка переменная (75) | Заголовок реквизита | ВнешнийПользователь |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | true |
- type | Строка (перечисление) | Тип реквизита:
| boolean |
Ответ: user (0..*) | |||
Нет параметров |
account/users/tenant/list
Список приложений, доступных пользователю абонента.
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
login | Строка переменная (50) | Логин пользователя | Abramov |
Ответ: tenants (0..*) | |||
id | Число (+7.0) | Номер приложения | 2000 |
role * | Строка (перечисление) | Роль пользователя абонента:
| administrator |
setup_required * | Булево | Требуется настройка прав в приложении | false |