Москва, Нагорный проезд д.7

Документация по интеграции с программно-аппаратным комплексом LightSorting

REST API

API интерфейс используется для того, чтобы интегрировать систему световой индикации в проект клиента. API предназначен для разработчиков и сопровождается детальной документацией.

REST API работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.

Все ссылки на запросы к API в данной документации включают обязательный основной URL:
http://{IP ADDRESS CONTROLLER}/api/v1

Где переменная {IP ADDRESS CONTROLLER} является IP адресом контроллера в Вашей локальной сети.

Вы можете использовать такие типы передачи данных как:

  • «application/x-www-form-urlencoded»
  • «application/json»

Для этого установите тип в заголовке запроса:

Content-Type: «application/x-www-form-urlencoded» или Content-Type: «application/json»

 

Для отладки вы можете использовать наш тестовый сервер

http://ponny.jelastic.regruhosting.ru/

 

Методы:

Включение маяка GET

/turn/on/{bagholder_name}/{number_cell}

Тип запроса GET

{bagholder_name} — Наименование бэгхолдера

{number_cell} — Номер ячейки

 

Включение маяка POST

/turn/on

Тип запроса POST

Тело запроса:

  • bagholder_name — Наименование бэгхолдера
  • number_cell — Номер ячейки

 

Выключение маяка GET

/turn/off/{bagholder_name}/{number_cell}

Тип запроса GET

{bagholder_name} — Наименование бэгхолдера

{number_cell} — Номер ячейки

 

Выключение маяка POST

/turn/off

Тип запроса POST

Тело запроса:

  • bagholder_name — Наименование бэгхолдера
  • number_cell — Номер ячейки

 

Включение всех маяков GET

/turn/all/on

Тип запроса GET

 

Выключение всех маяков GET

/turn/all/off

Тип запроса GET