Вернуться наверх
На этой странице:

11. Настройка пересылки событий ​

Пересылка событий необходима для точечной настройки получателей уведомлений по определенному событию.

Настройка пересылки сообщений осуществляется с использованием метода POST /front-api-srv/api/v.1.0/subscription. Укажите в запросе значения параметров, чтобы была выполнена настройка.

ПараметрТипТип данныхОбяз.ОписаниеПример
namebodystring+Наименование подписчикаПотребитель
callbacksbodyarray[object]+Массив конечных точек для подписчика-
subscriptionbodyobject+Объект параметров подписки-

object "callbacks"

ПараметрТипТип данныхОбяз.ОписаниеПример
addressbodystring+Адрес, куда отправляется событие

adress.info

topicNamebodystring-Название топика, в который отправляется событие (задается только при отправке в Kafka)

hans.name

usernamebodystring-Наименование пользователяUser 1
passwordbodystring-ПарольcWYYF3M6FibBerH

object "subscription"

ПараметрТипТип данныхОбяз.ОписаниеПример
tenantsbodyarray[string]-Массив тенантов, на события которых подписывается подписчик-
deviceTypesbodyarray[string]-Массив типов устройств, на которые подписывается подписчик-
eventTypesbodyarray[string]-Массив типов событий, на которые подписывается подписчик-

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

json
{
    "name": "Потребитель",
    "callbacks": [
        {
            "address": "adress.info",
            "topicName": "hans.name",
            "username": "User 1",
            "password": "cWYYF3M6FibBerH"
        }
    ],
    "subscription": {
        "tenants": [
            "{{ID тенанта}}"
        ],
        "deviceTypes": [
            "{{ID класса}}"
        ],
        "eventTypes": [
            "DeviceCreateEvent",
            "DeviceUpdateEvent"
        ]
    }
}

Пример ответа:

json
{
    "id": "d64cfcb4-de30-4ecd-b5de-e4e26cca66ce",
    "name": "Водоканал",
    "callbacks": [
        {
            "id": "cde8cf87-fee3-4fab-befd-c2ce9bf6acef",
            "address": "mike.info",
            "topicName": "hans.name",
            "username": "User 1",
            "password": "cWYYF3M6FibBerH"
        }
    ],
    "subscription": {
        "tenants": [],
        "thingClasses": [],
        "eventTypes": []
    },
    "tenantId": "00f00a00-e00f-0a00-af0a-c0af00e0ff00"
}