Свойства команд для HTTP-драйверов

Свойства команд для HTTP-драйверов

Сервер BOOCO / Конфигурирование драйверов оборудования / Структура конфигурационного файла драйвера / Раздел «Команды» (channels) /

Типовая структура HTTP-драйвера:

Driver name:
  # Раздел свойства драйвера
  property1: value1
  property2: value2
  # ...
  # Раздел обратные связи (feedbacks)
  feedbacks:
    - feedback1:
    # ...
  # Раздел команд (channels)
  channels:
    - nameChannel1: "значение канала 1"
    - nameChanne21: "значение канала 2"
  # ...
  # Раздел автоматических ответов
  replies:
    - reply1:
    # ...
  # Раздел событий
  events:
    - event1:
    # ...
  # Раздел опроса обратных связей (pollings)
  pollings:
    - channel1
    - channel2
  # ...

method

…

data-type

url

headers

Начиная с версии 1.41.6 в свойствах команд для http-драйвера вы можете указать заголовки — headers.

Для этого в разделе channels в подразделе getBookings в свойстве headers укажите параметры в формате:

headers:
  - nameValue1: "значение заголовка 1"
  - nameValue2: "значение заголовка 2"
💡
Важно. Используйте ровно два пробела в качестве отступа.

В качестве значений для headers в фигурных скобках можно указать:

  • названия переменных (их значения должны быть определены в разделе Свойства)
  • или названия обратных связей из раздела feedbacks.

Пример с headers для REST API сервера BOOCO:

channels:        
  - getBookings: string
    method: GET
    url: '/api/v1/venues?venueId=$V'
    headers:
      - X-Auth-Token: '{authToken}'
      - X-User-Id: '{userId}'

В этом примере:

  • method — метод запроса: какое действие нужно выполнить для ресурса;
  • url — путь к ресурсу, добавляется к базовому url команды в разделе Свойства;
  • headers — заголовки, берутся из документации для оборудования или сервиса.