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

Посетители API 1.5.0

Посетители, поиск, плановые визиты и свойства посетителей.

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

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

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

МетодПуть
GET/visitors
GET/visitors/count
GET/visitors/count_planned
GET/visitors/multisearch
GET/visitors/sort
GET/visitors/{uuid}/
GET/visitors_properties
GET/visitors_properties/{name}/
POST/visitors
POST/visitors_properties
PUT/visitors/{uuid}/
PUT/visitors_properties/{name}/
DELETE/visitors/{uuid}/
DELETE/visitors_properties/{name}/

GET /visitors​

Раздел: Посетители.

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

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

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

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

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

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

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

GET /visitors/count​

Раздел: Посетители.

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

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

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

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

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

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

{
  "count": 12
}

GET /visitors/count_planned​

Раздел: Посетители.

Возвращает количество посетителей, которые имеют статус «ожидается», их профили доступа (минимум один действительный), а также идентификаторы, которые действуют до параметра «end».

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

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

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

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

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

{
  "count": 12
}

GET /visitors/multisearch​

Раздел: Посетители.

Возвращает отсортированный по полю список с примененным поиском по ФИО и фильтрами.

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

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

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

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

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

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

GET /visitors/sort​

Раздел: Посетители.

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

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

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

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

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

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

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

GET /visitors/{uuid}/​

Раздел: Посетители.

Возвращает параметры конкретного посетителя по uuid.

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

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

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

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

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

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

GET /visitors_properties​

Раздел: Посетители.

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

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

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

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

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

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

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

GET /visitors_properties/{name}/​

Раздел: Посетители.

Возвращает параметры поля посетителя по его имени.

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

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

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

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

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

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

POST /visitors​

Раздел: Посетители.

Добавляет нового посетителя в систему.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/visitors" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Петров",
  "first_name": "Петр",
  "planned_at": "2026-06-16T09:00:00+03:00"
}'

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

{
  "last_name": "Петров",
  "first_name": "Петр",
  "planned_at": "2026-06-16T09:00:00+03:00"
}

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

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

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

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

POST /visitors_properties​

Раздел: Посетители.

Добавляет новое поле посетителя в систему.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/visitors_properties" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "department",
  "type": "string",
  "required": false
}'

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

{
  "name": "department",
  "type": "string",
  "required": false
}

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

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

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

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

PUT /visitors/{uuid}/​

Раздел: Посетители.

Редактирует посетителя добавленного в систему.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/visitors/{uuid}/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Петров",
  "first_name": "Петр",
  "planned_at": "2026-06-16T09:00:00+03:00"
}'

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

{
  "last_name": "Петров",
  "first_name": "Петр",
  "planned_at": "2026-06-16T09:00:00+03:00"
}

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

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

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

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

PUT /visitors_properties/{name}/​

Раздел: Посетители.

Редактирует параметры поля посетителя добавленного в систему.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/visitors_properties/{name}/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "department",
  "type": "string",
  "required": false
}'

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

{
  "name": "department",
  "type": "string",
  "required": false
}

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

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

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

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

DELETE /visitors/{uuid}/​

Раздел: Посетители.

Удаляет посетителя по идентификатору.

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

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

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

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

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

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

DELETE /visitors_properties/{name}/​

Раздел: Посетители.

Удаляет поле посетителя по имени.

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

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

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

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

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

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