Методы группы Account внешнего программного интерфейса Менеджера сервиса предназначены для обслуживания абонентов
Сводка по методам
Метод | Назначение |
---|---|
account/attached_info_for_subscribing | Дополнительные сведения абонента, нужные для оформления платной подписки |
account/confirm_sso_key | Подтвердить получение и активировать ключ SSO авторизации пользователей абонентов |
account/truncate_sso_key | Удалить все ключи SSO авторизации, кроме актуального |
account/update_attached_info | Обновить дополнительные реквизиты и сведения абонента |
account/update_sso_key | Отправить запрос на обновление ключа SSO авторизации |
account/customer_subscriptions/create | Создать новую подписку обслуживаемого абонента |
account/customer_subscriptions/create_enhanced | Создать новую подписку обслуживаемого абонента на расширение тарифа |
account/customer_subscriptions/create_upgrade | Создать новую подписку обслуживаемого абонента на апгрейд тарифа |
account/customer_subscriptions/extend | Создать расширяющую подписку обслуживаемого абонента |
account/customer_subscriptions/info | Информация о подписке обслуживаемого абонента |
account/customer_subscriptions/prolong | Создать продлевающую подписку обслуживаемого абонента |
account/customer_subscriptions/list | Cписок подписок обслуживаемых абонентов |
account/customer_subscriptions/renew | Возобновить подписку обслуживаемого абонента с другим сроком действия |
account/customer_subscriptions/set_servant_tariff | Установить тариф обслуживающей организации в существующей подписке |
account/customers/attached_info | Значения дополнительных реквизитов и сведений обслуживаемого абонента |
account/customers/fill_by_public_id | Заполнение сведений абонента по публичному идентификатору |
account/customers/info | Свойства и контактные данные обслуживаемого абонента |
account/customers/list | Cписок обслуживаемых абонентов |
account/customers/update_attached_info | Обновить дополнительные реквизиты и сведения обслуживаемого абонента |
account/site/list | Cписок сайтов обслуживающей организации для внешней регистрации |
account/attached_info_for_subscribing
Дополнительные сведения абонента, нужные для оформления платной подписки
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
Ответ | |||
errors | Булево | Признак наличия ошибок заполнения | false |
properties | Список (0..*) | Дополнительные сведения | |
- key | Строка переменная (100) | Имя свойства | Тариф |
- name * | Строка переменная (75) | Заголовок свойства | Тариф |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение свойства | Базовый |
- type | Строка (перечисление) | Тип свойства:
| additional_value |
- required * | Булево | Заполнять обязательно | true |
- tooltip * | Строка неограниченной длины | Подсказка | Текст подсказки. |
- error * | Булево | Признак ошибки | false |
- message * | Строка неограниченной длины | Описание ошибки | |
fields | Список (0..*) | Дополнительные реквизиты | |
- key | Строка переменная (100) | Имя реквизита | ИНН |
- name * | Строка переменная (75) | Заголовок реквизита | ИНН |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | 7799555550 |
- type | Строка (перечисление) | Тип реквизита:
| string |
- required * | Булево | Заполнять обязательно | true |
- tooltip * | Строка неограниченной длины | Подсказка | Текст подсказки. |
- error * | Булево | Признак ошибки | false |
- message * | Строка неограниченной длины | Описание ошибки |
account/confirm_sso_key
Подтвердить получение и активировать ключ SSO авторизации пользователей абонентов
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код обслуживающей организации | 1000 |
key_id | Уникальный идентификатор | Идентификатор ключа SSO авторизации | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
Ответ | |||
Нет параметров |
account/truncate_sso_key
Удалить все ключи SSO авторизации, кроме актуального
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код обслуживающей организации | 1000 |
actual_key_id | Уникальный идентификатор | Идентификатор актуального ключа SSO авторизации | abf7c2a7-1df7-4646-9327-2866804b6ce2 |
Ответ | |||
Нет параметров |
account/update_attached_info
Обновить дополнительные реквизиты и сведения абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код абонента | 1010 |
properties * | Дополнительные сведения | ||
- key | Строка переменная (100) | Имя свойства | Тариф |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение свойства | Базовый |
- type * | Строка (перечисление) | Тип свойства:
| additional_value |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ИНН |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | 7799555550 |
- type * | Строка (перечисление) | Тип реквизита:
| string |
Ответ | |||
Нет параметров |
account/update_sso_key
Отправить запрос на обновление ключа SSO авторизации
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код обслуживающей организации | 1000 |
key_id | Уникальный идентификатор | Идентификатор ключа SSO авторизации | abf7c2a7-1df7-4646-9327-2866804b6ce3 |
max_age | Число (+7.0) | Срок жизни ключа SSO авторизации | 1800 |
Ответ: key_id (1) | |||
Нет параметров |
account/customer_subscriptions/create
Создать новую подписку обслуживаемого абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
start | Дата и время в строке формата ISO | Начало действия | 02.12.2024 0:00:00 |
completion * | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
servant_tariff * | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
tariff * | Строка переменная (9) | Код тарифа - обязательно, если не указан servant_tariff (Код тарифа обслуживающей организации) | PROV00001 |
period * | Строка переменная (10) | Код периода действия | 1YR |
accept_intersections * | Булево | Допустимо наличие пересечений по периоду действия с имеющимися подписками на тот же тариф | true |
Ответ | |||
id * | Строка переменная (9) | Номер созданной подписки | 000000002 |
completion * | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
account/customer_subscriptions/create_enhanced
Создать новую подписку обслуживаемого абонента на расширение тарифа
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
start * | Дата и время в строке формата ISO | Начало действия | 02.12.2024 0:00:00 |
completion * | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
period * | Строка переменная (10) | Код периода действия | 1YR |
tariff | Строка переменная (9) | Код расширяющего тарифа | 000000002 |
servant_tariff * | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
parent | Строка переменная (9) | Номер основной подписки | 000000001 |
amount * | Число (+3.0) | Количество создаваемых подписок | 1 |
Ответ | |||
subscription | Список (0..*) | Список номеров созданных подписок | ["000000002"] |
subscription_info | Список (0..*) | Список завершений созданных подписок | |
- id | Строка переменная (9) | Номер созданной подписки | 000000002 |
- completion | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
account/customer_subscriptions/create_upgrade
Создать новую подписку обслуживаемого абонента на апгрейд тарифа
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
start * | Дата и время в строке формата ISO | Начало действия | 02.12.2024 0:00:00 |
period * | Строка переменная (10) | Код периода действия | 1YR |
tariff | Строка переменная (9) | Код тарифа-апгрейда | 000000002 |
servant_tariff * | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
parent | Строка переменная (9) | Номер основной подписки | 000000001 |
Ответ | |||
id * | Строка переменная (9) | Номер созданной подписки | 000000002 |
completion * | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
account/customer_subscriptions/extend
Создать расширяющую подписку обслуживаемого абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
id | Строка переменная (9) | Номер основной подписки | 000000001 |
Ответ: id (1) | |||
Нет параметров |
account/customer_subscriptions/info
Информация о подписке обслуживаемого абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant * | Число (+12.0) | Код ведущего абонента | 1000 |
account * | Число (+12.0) | Код обслуживаемого абонента | 1010 |
id | Строка переменная (9) | Номер подписки | 000000001 |
Ответ: subscription (1) | |||
id | Строка переменная (9) | Номер подписки | 000000001 |
created | Дата и время в строке формата ISO | Дата оформления подписки | 28.02.2019 10:00:00 |
updated * | Дата и время в строке формата ISO | Дата изменения подписки | 28.02.2019 10:00:00 |
start | Дата и время в строке формата ISO | Начало действия | 02.12.2024 0:00:00 |
completion | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
servant | Число (+12.0) | Код ведущего абонента | 1000 |
servant_tariff * | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
tariff | Строка переменная (9) | Код тарифа | PROV00001 |
period * | Строка переменная (10) | Код периода действия | 1YR |
parent * | Строка переменная (9) | Номер основной подписки | |
type | Строка (перечисление) | Тип подписки:
| basic |
amount | Число (+10.0) | Количество | 1 |
bill * | Строка переменная (9) | Номер счета на оплату | 000000001 |
bill_id * | Строка переменная (36) | Идентификатор счета на оплату | 00000000-0000-0000-0000-000000000000 |
services | Список (0..*) | Услуги | |
- id | Строка переменная (9) | Код услуги | 000000001 |
- name | Строка переменная (100) | Наименование услуги | Количество прав пользователей на запуск приложений |
- service_id | Строка переменная (50) | Идентификатор услуги | КоличествоПравПользователейНаЗапускПриложений |
- provider_name | Строка переменная (150) | Наименование поставщика услуги | Менеджер сервиса |
- provider_id | Строка переменная (50) | Идентификатор поставщика услуги | sm |
- description * | Строка неограниченной длины | Описание | |
- type | Строка (перечисление) | Тип услуги:
| limited |
- activation_status * | Строка (перечисление) | Состояние активации:
| activated |
- amount | Число (+10.0) | Количество лицензий | 1 |
- start_date * | Дата и время в строке формата ISO | Дата подключения | 01.01.2020 0:00:00 |
- end_date * | Дата и время в строке формата ISO | Дата отключения | 28.02.2020 0:00:00 |
account/customer_subscriptions/prolong
Создать продлевающую подписку обслуживаемого абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
id | Строка переменная (9) | Номер основной подписки | 000000001 |
Ответ: id (1) | |||
Нет параметров |
account/customer_subscriptions/list
Cписок подписок обслуживаемых абонентов
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
scope * | Массив из Строка (перечисление) | Параметры получения данных:
| ["services"] |
servant | Число (+12.0) | Код ведущего абонента | 1000 |
account * | Число (+12.0) | Код обслуживаемого абонента | 1010 |
active * | Булево | Получение только активных подписок | true |
basic * | Булево | Получение только основных подписок | false |
start_date * | Дата и время в строке формата ISO | Дата создания подписки. Начальная, для отбора по периоду | 01.01.2020 0:00:00 |
end_date * | Дата и время в строке формата ISO | Дата создания подписки. Конечная, для отбора по периоду | 28.02.2020 0:00:00 |
Ответ: subscription (0..*) | |||
id | Строка переменная (9) | Номер подписки | 000000001 |
created | Дата и время в строке формата ISO | Дата оформления подписки | 28.02.2019 10:00:00 |
updated * | Дата и время в строке формата ISO | Дата изменения подписки | 28.02.2019 10:00:00 |
start | Дата и время в строке формата ISO | Начало действия | 02.12.2024 0:00:00 |
completion | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
servant | Число (+12.0) | Код ведущего абонента | 1000 |
servant_tariff * | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
tariff | Строка переменная (9) | Код тарифа | PROV00001 |
period * | Строка переменная (10) | Код периода действия | 1YR |
parent * | Строка переменная (9) | Номер основной подписки | |
type | Строка (перечисление) | Тип подписки:
| basic |
amount | Число (+10.0) | Количество | 1 |
bill * | Строка переменная (9) | Номер счета на оплату | 000000001 |
bill_id * | Строка переменная (36) | Идентификатор счета на оплату | 00000000-0000-0000-0000-000000000000 |
services | Список (0..*) | Услуги | |
- id | Строка переменная (9) | Код услуги | 000000001 |
- name | Строка переменная (100) | Наименование услуги | Количество прав пользователей на запуск приложений |
- service_id | Строка переменная (50) | Идентификатор услуги | КоличествоПравПользователейНаЗапускПриложений |
- provider_name | Строка переменная (150) | Наименование поставщика услуги | Менеджер сервиса |
- provider_id | Строка переменная (50) | Идентификатор поставщика услуги | sm |
- description * | Строка неограниченной длины | Описание | |
- type | Строка (перечисление) | Тип услуги:
| limited |
- activation_status * | Строка (перечисление) | Состояние активации:
| activated |
- amount | Число (+10.0) | Количество лицензий | 1 |
- start_date * | Дата и время в строке формата ISO | Дата подключения | 01.01.2020 0:00:00 |
- end_date * | Дата и время в строке формата ISO | Дата отключения | 28.02.2020 0:00:00 |
account/customer_subscriptions/renew
Возобновить подписку обслуживаемого абонента с другим сроком действия
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
start * | Дата и время в строке формата ISO | Начало действия | 02.12.2024 0:00:00 |
completion * | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
id | Строка переменная (9) | Номер основной подписки | 000000001 |
period * | Строка переменная (10) | Код периода действия | 1YR |
accept_intersections * | Булево | Допустимо наличие пересечений по периоду действия с имеющимися подписками на тот же тариф | true |
Ответ | |||
id * | Строка переменная (9) | Номер созданной подписки | 000000002 |
completion * | Дата и время в строке формата ISO | Завершение действия | 01.12.2025 23:59:59 |
account/customer_subscriptions/set_servant_tariff
Установить тариф обслуживающей организации в существующей подписке
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
servant | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
id | Строка переменная (9) | Номер подписки | 000000001 |
servant_tariff | Строка переменная (9) | Код тарифа обслуживающей организации | SERV00001 |
Ответ | |||
Нет параметров |
account/customers/attached_info
Значения дополнительных реквизитов и сведений обслуживаемого абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+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/customers/fill_by_public_id
Заполнение сведений абонента по публичному идентификатору
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
public_id | Строка переменная (36) | Публичный идентификатор | 7713754211 |
Ответ | |||
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/customers/info
Свойства и контактные данные обслуживаемого абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
Ответ: customer (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 |
comment * | Строка переменная (255) | Комментарий | Пример комментария |
account/customers/list
Cписок обслуживаемых абонентов
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код ведущего абонента | 1000 |
scope * | Массив из Строка (перечисление) | Параметры получения данных:
| ["calculated_properties"] |
Ответ: customer (0..*) | |||
id | Число (+12.0) | Код абонента | 1010 |
name | Строка переменная (64) | Наименование абонента | Конфетпром |
public_id * | Строка переменная (36) | Публичный идентификатор | 123 |
email * | Строка переменная (500) | Адрес электронной почты | info@example.com |
calculated_properties | Список (0..*) | Вычисляемые свойства | calculated_properties |
- key | Строка переменная (100) | Имя свойства | КоличествоПриложенийАбонента |
- name * | Строка переменная (75) | Заголовок свойства | Количество приложений |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение свойства | 3 |
- type | Строка (перечисление) | Тип свойства:
| decimal |
fields | Список (0..*) | Доп. реквизиты | |
- key | Строка переменная (100) | Имя реквизита | ИНН |
- name * | Строка переменная (75) | Заголовок реквизита | ИНН |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | 7799555550 |
- type | Строка (перечисление) | Тип реквизита:
| string |
properties | Список (0..*) | Доп. сведения | |
- key | Строка переменная (100) | Имя свойства | Тариф |
- name * | Строка переменная (75) | Заголовок свойства | Тариф |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение свойства | Базовый |
- type | Строка (перечисление) | Тип свойства:
| additional_value |
account/customers/update_attached_info
Обновить дополнительные реквизиты и сведения обслуживаемого абонента
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
id | Число (+12.0) | Код ведущего абонента | 1000 |
account | Число (+12.0) | Код обслуживаемого абонента | 1010 |
public_id * | Строка переменная (36) | Публичный идентификатор | 7713754211 |
properties * | Дополнительные сведения | ||
- key | Строка переменная (100) | Имя свойства | Тариф |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение свойства | Базовый |
- type * | Строка (перечисление) | Тип свойства:
| additional_value |
fields * | Дополнительные реквизиты | ||
- key | Строка переменная (100) | Имя реквизита | ИНН |
- value * | Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, Булево | Значение реквизита | 7799555550 |
- type * | Строка (перечисление) | Тип реквизита:
| string |
Ответ: customer (0..*) | |||
Нет параметров |
account/site/list
Cписок сайтов обслуживающей организации для внешней регистрации
Параметр | Тип | Описание | Пример |
---|---|---|---|
Запрос | |||
account | Число (+12.0) | Код обслуживающей организации | 1000 |
Ответ: sites (0..*) | |||
site_id | Число (+9.0) | Код страницы внешней регистрации | 123 |
name | Строка переменная (64) | Наименование страницы внешней регистрации | 1С_ОбслуживающаяОрганизация |