Загальні правила

  • REST API доступний під основною URL-адресою:

/public/external/api

  • Усі запити мають бути надіслані через POST.
  • REST API підтримує запити тільки через HTTPS.
  • Запити повинні містити такі заголовки:
Редагувати

Назва заголовка



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



Опис



Тип вмісту



application/json



фіксований



авт.



123…xyz



Ключ API у вкладці “Доступ до API”



підпис



Підпис, закодований Base64



Підпис корисного навантаження, згенерованого за допомогою


приватний ключ у вкладці “Доступ до API”


  • Тіло запиту має бути об’єктом у форматі json, який повинен містити наступні значення:
Редагувати

Поле



Приклад поля Значення



Опис



api



v2/device/listdevices



Назва API



час



1529662725



Мітка часу Unix (UTC) клієнтської машини.


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


між клієнтом і сервером дорівнює 30


хвилин.


  • У разі успіху API повертає запитувані дані (див. Запити нижче) і код статусу HTTP 200.
  • У разі виникнення помилки HTTP-код статусу буде мати значення від 4xx до 5xx залежно від помилки, а об’єкт відповіді міститиме масив з ключем “errors”, який містить список повідомлень про помилки, які можна прочитати людиною.
  • Якщо для пристрою немає відповідних даних, буде повернуто порожній масив.
  • Якщо ідентифікатор пристрою не існує, дані, що повертаються, будуть нульовими.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.