Содержание
Публикация программного интерфейса
Программный интерфейс реализован как 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
Методы программного интерфейса менеджера относятся к одному из разделов:
- Действия пользователей — методы API, выполняющие действия, доступные пользователям абонентов сервиса
- Обслуживание инфраструктуры — методы API, выполняющие действия по обслуживанию инфраструктуры сервиса:
Действия пользователей
Это следующие группы методов API:
Группа | Назначение |
Управление свойствами абонентов, пользователями абонентов, подписками абонентов, обслуживаемых обслуживающей организацией | |
| Accounting_system | Работа с учетными системами |
Информация об уведомлениях о недоступности | |
Информация о прикладных конфигурациях «1С:Предприятия», доступных абоненту в сервисе | |
Управление архивными копиями приложений абонента | |
| Bill | Счета клиентам |
Работа с каталогом расширений конфигурации | |
| Integration_object | Работа с объектами интеграции |
Работа обслуживающих организаций с приглашениями для регистрации новых абонентов | |
Использование промо-кодов | |
Работа с активными сеансами пользователей с приложениями абонента | |
Управление подписками абонента | |
Информация о тарифах сервиса, доступных абоненту | |
| Task | Действия с задачами пользователя |
Управление приложениями абонента | |
Управление учетной записью пользователя сервиса | |
| Прочие методы | Методы, не входящие ни в одну из указанных выше групп |
Обслуживание инфраструктуры
Это следующие группы методов API:
Группа | Назначение |
Действия с кластерами серверов 1С:Предприятия | |
Действия с конфигурациями и версиями конфигураций | |
| Files | Действия с файлами |
Действия с информационными базами 1С:Предприятия | |
Действия с версиями платформы 1С:Предприятие |
Легенда описания методов
Маркировка входных и выходных параметров
| Пример | Значение |
|---|---|
| param_name * | Параметр не является обязательным для заполнения (может отсутствовать). |
| param_name ~* | Параметр не является обязательным только при каких-то определенных условиях. |
| param_name +* | Параметр всегда присутствует в структуре, но может иметь пустое значение. |
Описание ответа метода
| Пример | Значение |
|---|---|
| Нет параметров | В теле ответа возвращается только параметр general. Другие параметры в ответе отсутствуют. |
param_name (1) | В теле ответа дополнительно возвращается параметр param_name (тип Структура). |
| param_name (0|1..*) | В теле ответа дополнительно возвращается параметр param_name (тип Массив).Количество возможных элементов массива:
|
Отладка внешнего программного интерфейса
Для расследования ошибок и неясных ситуаций при использовании внешнего программного интерфейса менеджера сервиса администратор сервиса может включить режимы отладки внешнего программного интерфейса. Для этого администратор должен:
- Войти в менеджер сервиса.
- Выбрать в меню разделов раздел Администрирование.
- Выбрать в панели навигации в левой части экрана пункт Настройки интеграции.
- В выведенной форме Настройки интеграции установить:
- флажок Режим отладки внешнего программного интерфейса;
- при желании — также флажок Логировать тело запроса и ответа интерфейса.
При включенном флажке Режим отладки внешнего программного интерфейса сведения об обращениях к внешнему программному интерфейсу и его ответах записываются в журнал регистрации менеджера сервиса.
Флажки Режим отладки внешнего программного интерфейса и Логировать тело запроса и ответа интерфейса рекомендуется включать только в процессе отладки обращений к внешнему программному интерфейсу.