Лента событий документооборотов

Лента событий документооборотов — это поток событий об изменениях в документооборотах пользователей Контур.Экстерна. На основе ленты событий можно организовать оперативное уведомление пользователей об изменениях в их документооборотах, а также о получении новых документов от контролирующих органов.

Внимание

Права на использование методов ленты событий выдаются интегратору индивидуально по запросу. Для включения данной функциональности напишите нам: extern-api@skbkontur.ru.

Разрешение на чтение событий предоставляет администратор пользователя. В ленте появляются события только по тем видам документооборотов и форм отчетности, на которые пользователь выдал разрешение.

Чтение ленты событий можно сравнить с оформлением подписки: пользователи являются источниками, которые публикуют изменения. Интегратор — подписчик, который читает общую ленту новостей.

Получение ленты событий

Метод: GET Events

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

Параметрами запроса являются:

• идентификатор события, начиная с которого необходимо читать ленту;

• количество событий, которое нужно получить в ответе.

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

Каждое событие характеризуется набором параметров, которые помогут определить пользователя, которому принадлежит событие. Параметр new-state передает обновленный статус события, по которому можно понять суть изменений в документообороте пользователя. Подробное описание статусов событий указано в спецификации.

Разрешение пользователя на чтение событий

Метод: POST ShareEvents

Чтобы события об изменениях в документооборотах пользователей попали в ленту событий, администратор пользователя Контур.Экстерна должен дать разрешение на чтение этих событий. Метод выполняется от имени администратора, с его auth.sid.

В параметрах запроса нужно передать accountId, где данный пользователь имеет роль администратора.

В теле запроса необходимо передать параметр subscriber — это ваше сервисное имя, которое выдается при подключении ленты событий. Также в теле запроса можно передать фильтр событий по типам документооборотов и формам отчетности, по которым пользователь хочет разрешить чтение событий. Если фильтр не передан, по умолчанию разрешается чтение событий всех документооборотов и форм отчетности без ограничений.

Таким образом, пользователь предоставляет доступ на чтение его событий документооборотов по всем организациям для указанного в запросе subscriber и становится источником событий.

Получить информацию об источниках событий

Метод: GET EventPublishers

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

Отписаться от событий пользователя

Метод: DELETE EventsPublisher

Метод отменяет подписку на источник событий, чтобы изменения в документооборотах пользователей этого источника не отображались в ленте событий.