Общи правила

  • 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 Timestamp (UTC) на клиентската машина.


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


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


минути.


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