Общие правила

  • REST API доступен ниже базового URL:

/public/external/api

  • Все запросы должны быть отправлены через POST.
  • API REST поддерживает запросы только через HTTPS.
  • Запросы должны содержать следующие заголовки:
Редактировать

Название заголовка



Значение заголовка



Описание



Тип содержимого



приложение/json



исправлено



auth



123…xyz



Ключ API на вкладке «Доступ к API»



подпись



Подпись в кодировке Base64



Подпись полезной нагрузки, созданной с помощью


закрытый ключ на вкладке «Доступ к API»


  • Тело запроса должно представлять собой объект в кодировке json, который должен содержать следующие значения:
Редактировать

Поле



Поле Пример Значение



Описание



api



v2/device/listdevices



Название API



время



1529662725



Unix Timestamp (UTC) клиентской машины.


Максимально допустимая разница во времени


между клиентом и сервером составляет 30


минут.


  • В случае успеха API возвращает запрошенные данные (см. раздел «Запросы» ниже) и HTTP-код состояния 200.
  • Если произошла ошибка, код состояния HTTP будет от 4xx до 5xx в зависимости от ошибки, а объект ответа будет содержать массив с ключом «errors», который содержит список человекочитаемых сообщений об ошибках.
  • Если для устройства нет подходящих данных, будет возвращен пустой массив.
  • Если Id устройства не существует, то возвращаемые данные будут равны null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.