Представляет собой особый раздел WebAPI, предназначен для выполнения синхронизации и команд к 1С-Коннект напрямую из информационной базы 1С: Предприятие 8.3 организации.
Изначально задумывался как канал взаимодействия для Универсального расширения (плагина) типовой конфигурации интеграции с 1С-Коннект. Ввиду этого протокол реализовывался с учетом проблемы неявности авто-запуска механизмов информационной базы организации при её восстановлении/копировании системным администратором организации (т.е. алгоритм интеграции может быть не в единственном экземпляре, и может возникнуть непонимание "откуда же пришла на самом деле та или иная команда в облако 1С-Коннект").
Особенности реализации:
- На практике, в организации может быть более одной информационной базы для учета деятельности. Во избежание конфликтов синхронизации (или ошибок действий системного администратора), все команды "от лица" конкретной информационной системы должны идентифицироваться уникальным ключом-идентификатором InfobaseID. Вышеозначенный плагин самостоятельно генерирует ключ при первичном запуске в рамках конкретной информационной базы, и использует его в запросах BotAPI к облаку 1С-Коннект. Если организация желает самостоятельно реализовать взаимодействие через BotAPI, она должна взять организацию уникальности InfobaseID на себя.
- Данный протокол создавался для целей:
- полу-автоматической или автоматической синхронизации списка сотрудников в информационной системе организации со списком аккаунтов 1С-Коннект в рамках личного кабинета этой организации. В рамках этой задачи реализованы методы GetEmployeesList, AddEmployee, RestoreEmployee, DeleteEmployee.
- push-уведомлений сотрудников данной организации по указанной линии с конкретным содержанием. Для этой цели реализованы метод SendNotification.
- автоматической отправки/рассылки указанного файла указанному сотруднику по указанной линии. Для этой цели реализованы методы AddFile + SendFile. Т.к. один и тот же файл, возможно, большого размера, может потребоваться отправить нескольким адресатам, реализована двух-ступенчатая схема: ввиду ограничений SOAP, сначала необходимо отправить тело файла по HTTP-вызову AddFile, взамен получив уникальный идентификатор этого файла. Далее командой SendFile иницируете отправку файла указанному адресату, указав идентификатор этого файла (UUID). Можете вызвать команду SendFile несколько раз с одним идентификатором файла, тем самым отправив один и тот же файл нескольким адресатам.
- для осуществления рассылок и файлов по линиям адресатам, предусмотрены методы получения списка адресатов GetConsumersList, GetLinesToConsumers, а также списка линий GetSupportLinesList.
Состав команд: