Настройка узла обмена как потребителя API#
Сценарий настройки узла обмена как потребителя API. Выполняется через графический интерфейс прикладного решения 1С.
Авторизуйтесь в прикладном решении 1С:Предприятие с подключенным расширением OCPL.
Вызовите меню подсистемы «Synapse App Mesh».
Выберите пункт меню «Узлы обмена» для вызова списка справочника узлов обмена.
Создайте или выберите необходимый элемент справочника, используя командный интерфейс. Выберите команду:
«Создать» для создания нового элемента;
«Скопировать» для создания нового элемента путем копирования существующего элемента;
«Изменить» или двойной клик мышью для открытия существующего элемента.
Заполните поле «Наименование».
Если необходимо с описанием каждого объекта передавать ссылку на объект в формате OData - установите флаг «Публиковать OData».
Сохраните элемент нажатием кнопки «Записать».
Вызовите форму настройки узла нажатием кнопки «Настройки».
В открывшейся форме в дереве объектов метаданных установите флаги на тех объектах, по которым должны регистрироваться события создания, изменения и удаления.
Сохраните выбор нажатием кнопки «Сохранить и закрыть».
Вызовите формирование схемы OpenAPI для регистрации в каталоге API нажатием кнопки «Схема OpenAPI».
Скопируйте текст описания схемы OpenAPI или сохраните в файл json нажатием кнопки «Сохранить».
Раскройте группу элементов «Обмен по расписанию» нажатием на заголовок группы.
Установите флаг «Автоматически по расписанию».
Откройте интерфейс настройки расписания нажатием на гиперссылку «Расписание не задано». Если производится редактирование существующего узла обмена, гиперссылка будет иметь вид представления заданного расписания (например «каждый день; каждые 3 600 секунд»).
Выполните настройки расписания и закройте форму настройки расписания, сохранив настройки нажатием кнопки «ОК».
В поле «Сервер» укажите адрес сервиса, принимающего запросы (например, адрес Ingress на App Mesh).
В поле «Порт» укажите порт сервиса, принимающего запросы (например, порт Ingress на App Mesh).
Для защищенного соединения SSL установите флаг «Защищённое соединение (SSL)».
Настройте параметры выполнения запросов:
если необходимо выполнять запросы POST для отправки новых данных:
Установите флаг «Отправка данных».
Укажите путь на сервере для отправки «Path».
Если необходимо каждый объект отправлять отдельным запросом без использования массивов - установите флаг «отправлять каждый объект отдельным запросом».
Если нет необходимости получать в ответ массив идентификаторов успешно выгруженных объектов и достаточно подтверждения успешности выполнения запроса по HTTP-коду 200 - установите флаг «Подтверждать выгрузку HTTP OK». В таком случае все объекты, выгруженные в рамках одного запроса, будут считаться успешно обработанными и в следующую выгрузку не попадут.
если необходимо выполнять запросы GET для получения новых данных от внешней АС:
Установите флаг «Получение данных».
Укажите путь на сервере для получения «Path».
Если необходимо загружать все объекты в одной общей транзакции, для исключения дублирования объектов при возникновении ошибки при обработке одного из них - установите флаг «Загружать в одной транзакции».
Укажите параметры авторизации во внешней АС:
если внешняя АС требует авторизации по сертификату - выберите «Способ авторизации» «Сертификат», выберите требуемые сертификаты в параметрах авторизации;
если внешняя АС требует авторизации по логину и паролю - выберите «Способ авторизации» «Basic», укажите логин и пароль в параметрах авторизации.
если внешняя АС не требует авторизации - выберите «Без авторизации».
Сохраните настройки нажатием кнопки «Сохранить» или «Сохранить и закрыть».