Содержание

Публикация программного интерфейса

Программный интерфейс реализован как HTTP-сервис ExtAPI конфигурации «Менеджер сервиса».

Для того чтобы этот HTTP-сервис был доступен для вызова абонентами сервиса, следует включить в раздел httpServices файла внешней публикации менеджера сервиса следующий фрагмент:

<service name="ExtAPI" rootUrl="ext_api" enable="true"/>

В этом случае адрес для работы с api будет таким: https://{{server}}/a/adm/hs/ext_api/execute

Авторизация при обращении к API

При обращении к методам внешнего программного интерфейса необходимо указывать логин и пароль пользователя сервиса, от имени которого выполняется обращение.

Адреса методов API

Методы внешнего программного интерфейса перечислены в таблице.

МетодURLНазначение

Version

GET /hs/ext_api/version

Возвращает информацию о текущих версиях конфигурации менеджера сервиса и подсистемы «Программный интерфейс сервиса»

Execute

POST /hs/ext_api/execute

Инициирует выполнение указанного метода в информационной базе менеджера сервиса

Например, если внешняя публикация менеджера сервиса выполнена по адресу

https://сервер/a/adm

то для обращения к внешнему программному интерфейсу менеджера сервиса используются HTTP-запросы по адресам:

  • https://сервер/a/adm/hs/ext_api/version — получение версий внешнего программного интерфейса и менеджера сервиса;
  • https://сервер/a/adm/hs/ext_api/execute — выполнение метода внешнего программного интерфейса.

Разделы и группы методов API

Методы программного интерфейса менеджера относятся к одному из разделов:

  1. Действия пользователей — методы API, выполняющие действия, доступные пользователям абонентов сервиса
  2. Обслуживание инфраструктуры — методы API, выполняющие действия по обслуживанию инфраструктуры сервиса:

Действия пользователей

Это следующие группы методов API:

Группа

Назначение

Account

Управление свойствами абонентов, пользователями абонентов, подписками абонентов, обслуживаемых обслуживающей организацией

Alert

Информация об уведомлениях о недоступности

Application

Информация о прикладных конфигурациях «1С:Предприятия», доступных абоненту в сервисе

Backup

Управление архивными копиями приложений абонента

Extension

Работа с каталогом расширений конфигурации

Invitation

Работа обслуживающих организаций с приглашениями для регистрации новых абонентов

Promo_Code

Использование промо-кодов

Session

Работа с активными сеансами пользователей с приложениями абонента

Subscription

Управление подписками абонента

Tariff

Информация о тарифах сервиса, доступных абоненту

Tenant

Управление приложениями абонента

User

Управление учетной записью пользователя сервиса

Обслуживание инфраструктуры

Это следующие группы методов API:

Группа

Назначение

Cluster

Действия с кластерами серверов 1С:Предприятия

Configuration

Действия с конфигурациями и версиями конфигураций

Infobase

Действия с информационными базами 1С:Предприятия

Platform

Действия с версиями платформы 1С:Предприятие

Легенда описания методов

Маркировка входных и выходных параметров

ПримерЗначение
param_name *Параметр не является обязательным для заполнения (может отсутствовать).
param_name ~*Параметр не является обязательным только при каких-то определенных условиях.
param_name +*Параметр всегда присутствует в структуре, но может иметь пустое значение.

Описание ответа метода

ПримерЗначение
Нет параметровВ теле ответа возвращается только параметр general. Другие параметры в ответе отсутствуют.

param_name (1)

В теле ответа дополнительно возвращается параметр param_name (тип Структура).
param_name (0|1..*)

В теле ответа дополнительно возвращается параметр param_name (тип Массив).Количество возможных элементов массива:

  • 0..* — массив может быть пустым;
  • 1..* — массив должен содержать хотя бы один элемент.

Отладка внешнего программного интерфейса

Для расследования ошибок и неясных ситуаций при использовании внешнего программного интерфейса менеджера сервиса администратор сервиса может включить режимы отладки внешнего программного интерфейса. Для этого администратор должен:

  1. Войти в менеджер сервиса.
  2. Выбрать в меню разделов раздел Администрирование.
  3. Выбрать в панели навигации в левой части экрана пункт Настройки интеграции.
  4. В выведенной форме Настройки интеграции установить:
    • флажок Режим отладки внешнего программного интерфейса;
    • при желании — также флажок Логировать тело запроса и ответа интерфейса.

При включенном флажке Режим отладки внешнего программного интерфейса сведения об обращениях к внешнему программному интерфейсу и его ответах записываются в журнал регистрации менеджера сервиса.

Флажки Режим отладки внешнего программного интерфейса и Логировать тело запроса и ответа интерфейса рекомендуется включать только в процессе отладки обращений к внешнему программному интерфейсу.