Категория:SBIS API3

Данный API позволяет реализовать двустороннюю автоматическую синхронизировать объектов СБИС с внешней системой.

Термины:

• Connection - объект содержащий параметры синхронизации и настройки подключения, любая интеграция с внешней системой начинается с создания подключения к внешней системы через мастер в интерфейсе СБИС.
• ExtSyncDoc - объект содержащий данные одной итерации синхронизации - Список объектов синхронизации (ExtSyncObj) и направление обмена.
• ExtSybcObj - данные объекта синхронизации.

Порядок действий внешней системы для синхронизации данных с СБИС.

1. Создать ExtSyncDoc и поместить в него все изменившиеся в ИС объекты при помощи метода ExtSyncDoc.Write
2. Для созданного ExtSyncDoc вызывать метод подготовки данных ExtSyncDoc.Prepare. Метод вызывается до тех пор, пока все данные не будут подготовлены.
   1. Prepare проанализирует список объектов которые необходимо загрузить, и выдаст список вложенных объектов, которых не хватает для успешной загрузки. .
   2. Внешняя система добавляет в этот ExtSyncDoc необходимые объекты (Write) и продолжает вызывать Prepare.
3. После того как все данные загружены вызывает для ExtSyncDoc асинхронный метод метод ExtSyncDoc.Execute, который обновит в СБИС все указанные в ExtSyncDoc объекты.

Для двухсторонней синхронизации необходимо от ExtSyncDoc вызвать асинхронный метод getChanges, который добавит с данный документ список изменений со стороны СБИС и пометит конфликтные записи (записи у которых есть изменения с обеих сторон). Для разрешения конфликтов в СБИС есть соответствующий интерфейс доступный в истории синхронизации.

Получить данные для обновления во внешней системе, можно при помощи метода Read у объекта ExtSyncDoc с фильтром по направлению Export.

Данный API активно изменяется, фиксация планируется к концу 2021 года, поэтому актуально покрытие Вашей интеграции юнит тестами и постоянное тестирование на тестовом портале.