Перейти к содержанию

Структура запросов🔗

При составлении API-запроса нужно указать:

  • Тип действия. Если вы хотите сообщить или изменить параметры устройства, то нужно опубликовать параметры (тип действия publish). Для получения информации об оборудовании нужно подписаться на определенные топики (тип действия subscribe).
  • Тему запроса (топик) — используется в качестве ссылки, по которой передаются команды или информация.
  • Тело запроса — параметры оборудования в формате JSON при публикации.

Параметры топиков🔗

Топики представляют собой ссылки следующего вида:

Spread/{Topic_Type}/{Project_ID}/{Entity}/{Object_Type}/{Object_ID}/{Property}

Параметр Значение
Topic_Type Тип топика:
  • Set — топик изменения. Используется в запросах публикации (publish).
  • State — топик информации (статуса). Используется в запросах подписки (subscribe).
Project_ID ID проекта AWADA.
Entity Сущность:
  • Location — локация
  • Equipment — инженерный объект (оборудование)
  • Hardware — контроллер (менеджер, провайдер)
Object_Type Тип объекта
Object_ID ID объекта
Property Свойство, которое нужно изменить (или узнать текущий статус).

Примечание

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