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

Сервис биометрии ДИТ API 1.5.0

Настройки сервиса биометрии ДИТ и привязка точек прохода.

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

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

В исходном документе этот блок относится к сервису биометрии ДИТ. Значения clientSecret, password и другие секреты в примерах заменены placeholder-значениями.

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

МетодПуть
GET/biometry_services/dit
GET/biometry_services/dit/access_point
POST/biometry_services/dit
POST/biometry_services/dit/access_point
PUT/biometry_services/dit/access_point/{id}
PUT/biometry_services/dit/{id}
PATCH/biometry_services/dit/{id}
DELETE/biometry_services/dit/access_point/{id}
DELETE/biometry_services/dit/{id}

GET /biometry_services/dit​

Раздел: Сервис биометрии ДИТ.

Возвращает список параметров сервисов ДИТ.

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

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

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

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

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

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

GET /biometry_services/dit/access_point​

Раздел: Сервис биометрии ДИТ.

Возвращает список точек прохода работающие через ДИТ.

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

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

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

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

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

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/biometry_services/dit/access_point"
  }
}

POST /biometry_services/dit​

Раздел: Сервис биометрии ДИТ.

Создает новый сервис ДИТ в базе данных.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/biometry_services/dit" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}'

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

{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}

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

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

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

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

POST /biometry_services/dit/access_point​

Раздел: Сервис биометрии ДИТ.

Создает новую настройку для точки прохода через ДИТ.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/biometry_services/dit/access_point" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}'

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

{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}

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

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

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

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

PUT /biometry_services/dit/access_point/{id}​

Раздел: Сервис биометрии ДИТ.

Обновляет настройку точки прохода ДИТ.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/biometry_services/dit/access_point/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}'

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

{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}

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

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

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

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

PUT /biometry_services/dit/{id}​

Раздел: Сервис биометрии ДИТ.

Обновляет конфигурацию настроек ДИТ в базе данных.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}'

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

{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}

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

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

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

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

PATCH /biometry_services/dit/{id}​

Раздел: Сервис биометрии ДИТ.

Позволяет запустить или остановить работу сервиса ДИТ.

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

curl -k -X PATCH "https://{IP_контроллера}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}'

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

{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}

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

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

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

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

DELETE /biometry_services/dit/access_point/{id}​

Раздел: Сервис биометрии ДИТ.

Позволяет удалить настройку для точки прохода через ДИТ.

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

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

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

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

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

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

DELETE /biometry_services/dit/{id}​

Раздел: Сервис биометрии ДИТ.

Позволяет удалить сервис биометрии.

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

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

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

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

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

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