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

Точки прохода API 1.5.0

Точки прохода, режимы, параметры и состояние прохода.

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

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

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

МетодПуть
GET/access_points
GET/access_points/ext_parameters
GET/access_points/ext_parameters/sections
GET/access_points/{uuid}
GET/access_points_automations
GET/access_points_automations/{uuid}
POST/access_points/barrier
POST/access_points/double
POST/access_points/mantrap
POST/access_points/single
POST/access_points/turnstile
POST/access_points/turnstile_with_card_box
POST/access_points/{uuid}/state/{state}
POST/access_points_automations
PUT/access_points/barrier/{uuid}
PUT/access_points/double/{uuid}
PUT/access_points/mantrap/{uuid}
PUT/access_points/single/{uuid}
PUT/access_points/turnstile/{uuid}
PUT/access_points/turnstile_with_card_box/{uuid}
PUT/access_points_automations/{uuid}
DELETE/access_points/{uuid}
DELETE/access_points_automations/{uuid}

GET /access_points

Раздел: Точки прохода.

Возвращает список всех созданных точек прохода.

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

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

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

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

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

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/access_points"
}
}

GET /access_points/ext_parameters

Раздел: Точки прохода.

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

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

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

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

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

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

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/access_points/ext_parameters"
}
}

GET /access_points/ext_parameters/sections

Раздел: Точки прохода.

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

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

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

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

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

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

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/access_points/ext_parameters/sections"
}
}

GET /access_points/{uuid}

Раздел: Точки прохода.

Возвращает параметры конкретной точки прохода по uuid.

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

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

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

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

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

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/access_points/{uuid}"
}
}

GET /access_points_automations

Раздел: Точки прохода.

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

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

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

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

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

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

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/access_points_automations"
}
}

GET /access_points_automations/{uuid}

Раздел: Точки прохода.

Возвращает список настроек конкретной автоматизации точки прохода по uuid.

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

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

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

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

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

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/access_points_automations/{uuid}"
}
}

POST /access_points/barrier

Раздел: Точки прохода.

Добавляет новую точку прохода - шлагбаум.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points/barrier" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

POST /access_points/double

Раздел: Точки прохода.

Добавляет новую точку прохода - двустороннюю.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points/double" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

POST /access_points/mantrap

Раздел: Точки прохода.

Добавляет новую точку прохода - Шлюз.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points/mantrap" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

POST /access_points/single

Раздел: Точки прохода.

Добавляет новую точку прохода - одностороннюю.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points/single" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

POST /access_points/turnstile

Раздел: Точки прохода.

Добавляет новую точку прохода - турникет.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points/turnstile" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

POST /access_points/turnstile_with_card_box

Раздел: Точки прохода.

Добавляет новую точку прохода - турникет с картоприемником.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points/turnstile_with_card_box" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

POST /access_points/{uuid}/state/{state}

Раздел: Точки прохода.

Передает точке прохода режим работы.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points/{uuid}/state/{state}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

POST /access_points_automations

Раздел: Точки прохода.

Добавляет автоматизацию для точки прохода.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/access_points_automations" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

PUT /access_points/barrier/{uuid}

Раздел: Точки прохода.

Редактирует существующую точку прохода - шлагбаум.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_points/barrier/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

PUT /access_points/double/{uuid}

Раздел: Точки прохода.

Редактирует существующую точку прохода – двустороннюю по uuid.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_points/double/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

PUT /access_points/mantrap/{uuid}

Раздел: Точки прохода.

Редактирует существующую точку прохода - шлюз по uuid.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_points/mantrap/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный шлюз",
"type": "mantrap",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный шлюз",
"type": "mantrap",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

PUT /access_points/single/{uuid}

Раздел: Точки прохода.

Редактирует существующую точку прохода – одностороннюю по uuid.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_points/single/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

PUT /access_points/turnstile/{uuid}

Раздел: Точки прохода.

Редактирует существующую точку прохода – турникет по uuid.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_points/turnstile/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

PUT /access_points/turnstile_with_card_box/{uuid}

Раздел: Точки прохода.

Редактирует существующую точку прохода - турникет с картоприемником.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_points/turnstile_with_card_box/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

PUT /access_points_automations/{uuid}

Раздел: Точки прохода.

Редактирует существующую автоматизацию точки прохода.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_points_automations/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'

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

{
"name": "Главный вход",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}

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

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

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

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

DELETE /access_points/{uuid}

Раздел: Точки прохода.

Удаляет существующую точку прохода.

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

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

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

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

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

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

DELETE /access_points_automations/{uuid}

Раздел: Точки прохода.

Удаляет существующую автоматизацию точки прохода.

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

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

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

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

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

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