Триггеры - это специальный механизм, позволяющий приложениям получать HTTP-уведомления от сервера ГосПлан (или webhook) по факту наступления определенных событий.

Например, Вы можете через API дать команду серверу выполнить определенный запрос при изменении состояния закупки. В случае публикации в ЕИС нового документа или изменения состояния закупки по наступлении определенного времени, сервер может уведомить Ваше приложение POST-запросом.

В зависимости от того, какие закупки планируете отслеживать, запросы выполняются на соответствующие сервер: триггеры по 44-ФЗ - https://fz44.gosplan.info, триггеры по 223-ФЗ - https://223.gosplan.info.

Принцип работы

Общая схема

1. Ваше (клиентское) приложение выполняет POST-запрос на сервер ГосПлан API и указывает в параметрах номер закупки, состояние которой необходимо отслеживать, и URL на который необходимо выполнить запрос.

2. В случае, если сервер ГосПлан API фиксирует изменение состояния закупки (например, при синхронизации с ЕИС или при наступлении контрольного времени), выполняется POST-запрос на URL, который был указан в п. 1. При следующем изменении состоянии закупки запрос будет выполнен повторно (на рис. - шаг 2')

3. Для завершения отслеживания состояния закупки, клиентское приложение отправляет DELETE-запрос на удаление триггера.

Создание триггера

Перед началом использования триггеров Вам необходимо задать адрес Вашего приложения на странице приложения https://dev.gosplan.info​

Необходимо указать такой домен приложения, в котором будет обрабатываться запросы от API-сервера.

В зависимости от того, какие закупки планируете отслеживать, запросы выполняются на соответствующие сервер: триггеры по 44-ФЗ - https://fz44.gosplan.info, триггеры по 223-ФЗ - https://223.gosplan.info.

Формат запроса для создания триггера

POST /api/v1/purchases/events

Тело запроса

{
    "event": {
        "purchase_number": "123123",
        "callback_url": "https://my.app1.com/callback",
        "state": "secret"
    }
}

Параметры ответа

{
    "id": 1,
    "type": "PurchaseEvent",
    "api_key": "123",
    "number": "123123",
    "state": "secret",
    "callback_url": "https://my.app1.com/callback",
    "created_at": "2021-03-04T23:38:02.377+03:00",
    "updated_at": "2021-03-04T23:38:02.377+03:00"
}

{
    "error": "Текст ошибки"
}

В случае, если при создании триггера получен статус 200 или 201, то API сервер сохранил необходимые данные и может выполнять HTTP-запросы к Вашему приложению.

Webhook

События, связанные с триггерами, возникают на API-сервере в момент синхронизации с ЕИС, либо в момент срабатывания контрольного времени.

Формат запроса Webhook-а

POST https://my.app1.com/callback

Тело запроса

{
    "type": "PurchaseEvent",
    "number": "123123",
    "scope": "fz44",
    "state": "secret"
}

В случае, если HTTP статус ответа на запрос вебхука отличается от 2XX, то запрос повторяется еще 2 раза.

Удаление триггера

В случае, если события триггера более не актуальны рекомендуется удалить триггер:

Формат запроса на удаление триггера

DELETE /api/v1/purchases/events/:purchase_number

В не зависимости от существования триггера, HTTP-статус ответа - 204. Тело ответа отсутствует.

Просмотр триггеров

Для просмотра существующих триггеров, Вы можете воспользоваться запросами для получения списка активных триггеров и получения триггера по номеру закупки.

Получение списка триггеров

GET /api/v1/purchases/events?page=1&per=20

Параметры запроса в URL-е

Тело ответа

[
    {
        "callback_url": "https://my.app1.com/callback",
        "purchase_number": "123123",
        "state": "secret"
    },
    ...
]

Заголовки ответа

Получение триггера по номеру

GET /api/v1/purchases/events/:purchase_number

Тело ответа совпадает с ответом на запрос создания триггера.

​

​