Перейти к основному содержимому

Устройства API 1.6.0

Контроллеры, периферия и состояние устройств.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.6.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/devices
GET/devices/by_controller/{controller}
GET/devices/controllers_list
GET/devices/count
GET/devices/find
GET/devices/have_errors
GET/devices/have_notifications
GET/devices/{uuid}
POST/devices/action
DELETE/devices/{uuid}

GET /devices​

Раздел: Устройства.

Возвращает постраничный список устройств с параметрами.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/devices"
  }
}

GET /devices/by_controller/{controller}​

Раздел: Устройства.

Возвращает параметры контроллера и связанных с ним модулей по серийному номеру.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices/by_controller/{controller}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices/by_controller/{controller}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/devices/by_controller/{controller}"
  }
}

GET /devices/controllers_list​

Раздел: Устройства.

Возвращает список серийных номеров контроллеров.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices/controllers_list" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices/controllers_list" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/devices/controllers_list"
  }
}

GET /devices/count​

Раздел: Устройства.

Возвращает количество добавленных в систему устройств.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices/count" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices/count" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "count": 12
}

GET /devices/find​

Раздел: Устройства.

Возвращает список параметров подключенного устройства по номеру контроллера и адресу в сегменте.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices/find?controller=00000583&device_address=/1/1" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices/find?controller=00000583&device_address=/1/1" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

[
  {
    "uuid": "<device_uuid>",
    "controller": "00000583",
    "address": "/1/1",
    "name": "Считыватель"
  }
]

GET /devices/have_errors​

Раздел: Устройства.

Возвращает постраничный список устройств с ошибками.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices/have_errors" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices/have_errors" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/devices/have_errors"
  }
}

GET /devices/have_notifications​

Раздел: Устройства.

Возвращает постраничный список устройств с событиями оповещения.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices/have_notifications" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices/have_notifications" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/devices/have_notifications"
  }
}

GET /devices/{uuid}​

Раздел: Устройства.

Возвращает параметры устройства по его uuid.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/devices/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/devices/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/devices/{uuid}"
  }
}

POST /devices/action​

Раздел: Устройства.

Генерация аппаратного события.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/devices/action" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "<device_uuid>",
  "action": "restart"
}'

Пример тела запроса​

{
  "uuid": "<device_uuid>",
  "action": "restart"
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/devices/action" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /devices/{uuid}​

Раздел: Устройства.

Позволяет удалить устройство с определенным UUID.

Пример запроса​

curl -k -X DELETE "https://{IP_контроллера}/api/v1/devices/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/devices/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "deleted": true
}