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

Методы API для работы с разделом «Сервис биометрии ДИТ».

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

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

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

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

`GET /biometry_services/dit`

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

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

Источник в Teamly

Назначение	URL запроса
Возвращает список параметров сервисов ДИТ	https://{IP_контроллера}/api/v1/biometry_services/dit

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

Название, * - обязательный	Тип	Формат	Назначение
uuid*	string	pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$	Уникальный идентификатор интеграции
name	string	example: РС ЕБС (ДИТ г.Москвы)	Имя интеграции
controller	string		Контроллер сервиса
host*	string	example: https://10.23.64.140	IP-адрес или хост сервиса с указанием протокола (http:// или https://)
authHost	string	example: https://10.23.64.140	IP-адрес или хост для авторизации с указанием протокола (http:// или https://)
authPort*	number	example: 30415	Порт для аутентификации
apiPort*	number	example: 30417	Порт для API
basePath	string	example: /v1	Базовый путь
authBasePath	string	example: /v1	Базовый путь для авторизации
clientId*	string	example: rub-test	Идентификатор клиента
clientSecret*	string	example: 1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0	Секретное значение клиента
username*	string	example: rub-test	Имя пользователя для доступа к сервису
password*	string	example: 1AAbgZ9zmwIgo3Hwa8B	Пароль для доступа к сервису
kafkaBroker*	string	example: 10.23.64.142:31133	Адрес и порт Kafka-брокера
kafkaTopic	string	example: ebs_event_rub	Имя топика Kafka для событий биометрии
active	boolean		Состояние сервиса (включен/выключен)

Пример:

[
  {
    "uuid": "string",
    "name": "РС ЕБС (ДИТ г.Москвы)",
    "controller": "string",
    "host": "https://10.23.64.140",
    "authHost": "https://10.23.64.140",
    "authPort": 30415,
    "apiPort": 30417,
    "basePath": "/v1",
    "authBasePath": "/v1",
    "clientId": "rub-test",
    "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
    "username": "rub-test",
    "password": "xEEXtsRE%7B%5B7bCEy",
    "kafkaBroker": "10.23.64.142:31133",
    "kafkaTopic": "ebs_event_rub",
    "active": true
  }
]

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Возвращает список сервисов ДИТ",
  "responses": {
    "200": {
      "description": "Указанная страница зарегистрированных карт успешно возвращена",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "uuid",
                "host",
                "clientId",
                "clientSecret",
                "username",
                "password",
                "kafkaBroker"
              ],
              "properties": {
                "uuid": {
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "name": {
                  "type": "string",
                  "example": "РС ЕБС (ДИТ г.Москвы)"
                },
                "controller": {
                  "type": "string"
                },
                "host": {
                  "type": "string",
                  "description": "IP-адрес или хост сервиса с указанием протокола (http:// или https://).",
                  "example": "https://10.23.64.140"
                },
                "authHost": {
                  "type": "string",
                  "description": "IP-адрес или хост для авторизации с указанием протокола (http:// или https://).",
                  "example": "https://10.23.64.140"
                },
                "clientId": {
                  "type": "string",
                  "description": "Идентификатор клиента.",
                  "example": "rub-test"
                },
                "clientSecret": {
                  "type": "string",
                  "description": "Секрет клиента.",
                  "example": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0"
                },
                "username": {
                  "type": "string",
                  "description": "Имя пользователя для доступа к сервису.",
                  "example": "rub-test"
                },
                "password": {
                  "type": "string",
                  "description": "Пароль для доступа к сервису.",
                  "example": "xEEXtsRE%7B%5B7bCEy"
                },
                "kafkaBroker": {
                  "type": "string",
                  "description": "Адрес и порт Kafka-брокера.",
                  "example": "10.23.64.142:31133"
                },
                "kafkaTopic": {
                  "type": "string",
                  "description": "Имя топика Kafka для событий биометрии.",
                  "example": "ebs_event_rub"
                },
                "active": {
                  "type": "boolean",
                  "description": "Включен/выключен"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

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

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

[
  {
    "uuid": "string",
    "name": "РС ЕБС (ДИТ г.Москвы)",
    "controller": "string",
    "host": "https://10.23.64.140",
    "authHost": "https://10.23.64.140",
    "clientId": "rub-test",
    "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
    "username": "rub-test",
    "password": "xEEXtsRE%7B%5B7bCEy",
    "kafkaBroker": "10.23.64.142:31133",
    "kafkaTopic": "ebs_event_rub",
    "active": true
  }
]

`POST /biometry_services/dit`

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

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

Источник в Teamly

Назначение	URL запроса
Создает новый сервис ДИТ в базе данных	https://{IP_контроллера}/api/v1/biometry_services/dit

Параметры запроса:

Название	Тип	Описание
biometry_services*	object(body)	Тело запроса
BODY
Название * - обязательный	Тип	Формат	Назначение
uuid*	string	pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$	Уникальный идентификатор интеграции
name	string	example: РС ЕБС (ДИТ г.Москвы)	Имя интеграции
controller	string		Контроллер сервиса
host*	string	example: https://10.23.64.140	IP-адрес или хост сервиса с указанием протокола (http:// или https://)
authHost	string	example: https://10.23.64.140	IP-адрес или хост для авторизации с указанием протокола (http:// или https://)
authPort*	number	example: 30415	Порт для аутентификации
apiPort*	number	example: 30417	Порт для API
basePath	string	example: /v1	Базовый путь
authBasePath	string	example: /v1	Базовый путь для авторизации
clientId*	string	example: rub-test	Идентификатор клиента
clientSecret*	string	example: 1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0	Секретное значение клиента
username*	string	example: rub-test	Имя пользователя для доступа к сервису
password*	string	example: 1AAbgZ9zmwIgo3Hwa8B	Пароль для доступа к сервису
kafkaBroker*	string	example: 10.23.64.142:31133	Адрес и порт Kafka-брокера
kafkaTopic	string	example: ebs_event_rub	Имя топика Kafka для событий биометрии
active	boolean		Состояние сервиса (включен/выключен)

Пример:

URL запроса: POST
https://{IP_контроллера}/api/v1/biometry_services/dit

Body

{
  "uuid": "string",
  "name": "РС ЕБС (ДИТ г.Москвы)",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "authPort": 30415,
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}

Варианты ответа:

Code 201 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 409 (Service with specified uuid already exists) - запрос не выполнен, сервис уже добавлен

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Создает новый сервис ДИТ в базе данных",
  "requestBody": {
    "description": "Настройка нового сервиса ДИТ в базе данных",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "uuid",
            "host",
            "clientId",
            "clientSecret",
            "username",
            "password",
            "kafkaBroker"
          ],
          "properties": {
            "uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "name": {
              "type": "string",
              "example": "РС ЕБС (ДИТ г.Москвы)"
            },
            "controller": {
              "type": "string"
            },
            "host": {
              "type": "string",
              "description": "IP-адрес или хост сервиса с указанием протокола (http:// или https://).",
              "example": "https://10.23.64.140"
            },
            "authHost": {
              "type": "string",
              "description": "IP-адрес или хост для авторизации с указанием протокола (http:// или https://).",
              "example": "https://10.23.64.140"
            },
            "clientId": {
              "type": "string",
              "description": "Идентификатор клиента.",
              "example": "rub-test"
            },
            "clientSecret": {
              "type": "string",
              "description": "Секрет клиента.",
              "example": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0"
            },
            "username": {
              "type": "string",
              "description": "Имя пользователя для доступа к сервису.",
              "example": "rub-test"
            },
            "password": {
              "type": "string",
              "description": "Пароль для доступа к сервису.",
              "example": "xEEXtsRE%7B%5B7bCEy"
            },
            "kafkaBroker": {
              "type": "string",
              "description": "Адрес и порт Kafka-брокера.",
              "example": "10.23.64.142:31133"
            },
            "kafkaTopic": {
              "type": "string",
              "description": "Имя топика Kafka для событий биометрии.",
              "example": "ebs_event_rub"
            },
            "active": {
              "type": "boolean",
              "description": "Включен/выключен"
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Сервис успешно добавлен",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Сервис уже существует",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/biometry_services/dit" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "name": "РС ЕБС (ДИТ г.Москвы)",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}'

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

{
  "uuid": "string",
  "name": "РС ЕБС (ДИТ г.Москвы)",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}

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

{
  "success": false,
  "message": "string",
  "data": {}
}

`GET /biometry_services/dit/access_point`

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

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

Источник в Teamly

Назначение	URL запроса
Возвращает список точек прохода работающие через ДИТ	https://{IP_контроллера}/api/v1/biometry_services/dit/access_point

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

Название, * - обязательный	Тип	Формат	Назначение
service_uuid	string		UUID сервиса биометрии, к которому привязывается точка
access_point_uuid*	string		Уникальный идентификатор точки прохода
cameraConfig*	{		Конфигурация камер
description:	string		Ключ - считыватель точки прохода, значение - ID камеры
	}
accessLabels	{		Метки доступа для камер
description:	string		Ключ - считыватель точки прохода, значение - метка доступа
	}
name*	string		Название точки прохода
uuid*	string		Уникальный идентификатор точки прохода

Пример:

[
  {
    "service_uuid": "string",
    "access_point_uuid": "string",
    "cameraConfig": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "accessLabels": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "name": "string",
    "uuid": "string"
  }
]

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Возвращает список точек доступа ДИТ",
  "responses": {
    "200": {
      "description": "Список точек доступа успешно возвращен",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "access_point_uuid",
                "cameraConfig",
                "name",
                "uuid"
              ],
              "properties": {
                "service_uuid": {
                  "type": "string",
                  "description": "Uuid сервиса биометрии, к которому привязывается точка."
                },
                "access_point_uuid": {
                  "type": "string",
                  "description": "Уникальный идентификатор точки прохода."
                },
                "cameraConfig": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  },
                  "description": "Конфигурация камер. Ключ - считыватель точки прохода, значение - ID камеры."
                },
                "accessLabels": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  },
                  "description": "Метки доступа для камер. Ключ - считыватель точки прохода, значение - метка доступа."
                },
                "name": {
                  "type": "string",
                  "description": "Название точки прохода."
                },
                "uuid": {
                  "type": "string",
                  "description": "Уникальный идентификатор точки прохода."
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

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

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

[
  {
    "service_uuid": "string",
    "access_point_uuid": "string",
    "cameraConfig": {},
    "accessLabels": {},
    "name": "string",
    "uuid": "string"
  }
]

`POST /biometry_services/dit/access_point`

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

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

Источник в Teamly

Назначение	URL запроса
Создает новую настройку для точки прохода через ДИТ	https://{IP_контроллера}/api/v1/biometry_services/dit/access_point

Параметры запроса:

Название	Тип	Описание
access_point*	object(body)	Тело запроса
BODY
Название * - обязательный	Тип	Формат	Назначение
service_uuid	string		UUID сервиса биометрии, к которому привязывается точка
access_point_uuid*	string		Уникальный идентификатор точки прохода
cameraConfig*	{		Конфигурация камер
description:	string		Ключ - считыватель точки прохода, значение - ID камеры
	}
accessLabels	{		Метки доступа для камер
description:	string		Ключ - считыватель точки прохода, значение - метка доступа
	}
name*	string		Название точки прохода
uuid*	string		Уникальный идентификатор точки прохода

Пример:

URL запроса: POST
https://{IP_контроллера}/api/v1/biometry_services/dit/access_point

Body

{
  "service_uuid": "string",
  "access_point_uuid": "string",
  "cameraConfig": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "accessLabels": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "uuid": "string"
}

Варианты ответа:

Code 201 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 409 (Access point with specified uuid already exists) - запрос не выполнен, точка доступа с таким uuid уже добавлена

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Создает новую точку доступа ДИТ",
  "requestBody": {
    "description": "Настройка нового сервиса ДИТ в базе данных",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "access_point_uuid",
            "cameraConfig",
            "name",
            "uuid"
          ],
          "properties": {
            "service_uuid": {
              "type": "string",
              "description": "Uuid сервиса биометрии, к которому привязывается точка."
            },
            "access_point_uuid": {
              "type": "string",
              "description": "Уникальный идентификатор точки прохода."
            },
            "cameraConfig": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              },
              "description": "Конфигурация камер. Ключ - считыватель точки прохода, значение - ID камеры."
            },
            "accessLabels": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              },
              "description": "Метки доступа для камер. Ключ - считыватель точки прохода, значение - метка доступа."
            },
            "name": {
              "type": "string",
              "description": "Название точки прохода."
            },
            "uuid": {
              "type": "string",
              "description": "Уникальный идентификатор точки прохода."
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Конфигурация успешно добавлена",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Конфигурация уже существует",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

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

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

{
  "service_uuid": "string",
  "access_point_uuid": "string",
  "cameraConfig": {},
  "accessLabels": {},
  "name": "string",
  "uuid": "string"
}

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

{
  "success": false,
  "message": "string",
  "data": {}
}

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

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

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

Источник в Teamly

Назначение	URL запроса
Обновляет настройку точки прохода ДИТ	https://{IP_контроллера}/api/v1/biometry_services/dit/access_point/{id}

Параметры запроса:

Название	Тип	Описание
id*	string (path)	Уникальный идентификатор
BODY
Название * - обязательный	Тип	Формат	Назначение
service_uuid	string		UUID сервиса биометрии, к которому привязывается точка
access_point_uuid*	string		Уникальный идентификатор точки прохода
cameraConfig*	{		Конфигурация камер
description:	string		Ключ - считыватель точки прохода, значение - ID камеры
	}
accessLabels	{		Метки доступа для камер
description:	string		Ключ - считыватель точки прохода, значение - метка доступа
	}
name*	string		Название точки прохода
uuid*	string		Уникальный идентификатор точки прохода

Пример:

URL запроса: PUT

https://{IP_контроллера}/api/v1/biometry_services/dit/access_point/{id}

Body

{
  "service_uuid": "string",
  "access_point_uuid": "string",
  "cameraConfig": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "accessLabels": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "uuid": "string"
}

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 409 (Access point with specified uuid already exists) - запрос не выполнен, точка прохода с таким uuid уже добавлена

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Обновить точку доступа ДИТ",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "description": "Обновление сервиса ДИТ в базе данных",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "access_point_uuid",
            "cameraConfig",
            "name",
            "uuid"
          ],
          "properties": {
            "service_uuid": {
              "type": "string",
              "description": "Uuid сервиса биометрии, к которому привязывается точка."
            },
            "access_point_uuid": {
              "type": "string",
              "description": "Уникальный идентификатор точки прохода."
            },
            "cameraConfig": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              },
              "description": "Конфигурация камер. Ключ - считыватель точки прохода, значение - ID камеры."
            },
            "accessLabels": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              },
              "description": "Метки доступа для камер. Ключ - считыватель точки прохода, значение - метка доступа."
            },
            "name": {
              "type": "string",
              "description": "Название точки прохода."
            },
            "uuid": {
              "type": "string",
              "description": "Уникальный идентификатор точки прохода."
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Точка доступа ДИТ успешно добавлена",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "409": {
      "description": "Точка доступа ДИТ уже существует",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

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 '{
  "service_uuid": "string",
  "access_point_uuid": "string",
  "cameraConfig": {},
  "accessLabels": {},
  "name": "string",
  "uuid": "string"
}'

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

{
  "service_uuid": "string",
  "access_point_uuid": "string",
  "cameraConfig": {},
  "accessLabels": {},
  "name": "string",
  "uuid": "string"
}

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

{
  "success": false,
  "message": "string",
  "data": {}
}

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

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

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

Источник в Teamly

Назначение	URL запроса
Позволяет удалить настройку для точки прохода через ДИТ	https://{IP_контроллера}/api/v1/biometry_services/dit/access_point/{id}

Параметры запроса:

Наименование, * - обязательный	Описание
id* string (path)	Уникальный идентификатор

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 404 (Access point with specified id was not found) - запрос не выполнен, указанная точка прохода не найдена

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Удалить точку доступа ДИТ",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Успешно удалено",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Точка доступа не существует",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

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

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

{
  "success": false,
  "message": "string",
  "data": {}
}

`PUT /biometry_services/dit/{id}`

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

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

Источник в Teamly

Назначение	URL запроса
Обновляет конфигурацию настроек ДИТ в базе данных	https://{IP_контроллера}/api/v1/biometry_services/dit/{id}

Параметры запроса:

Название	Тип	Описание
id*	string (path)	Уникальный идентификатор
BODY
Название * - обязательный	Тип	Формат	Назначение
uuid*	string	pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$	Уникальный идентификатор интеграции
name	string	example: РС ЕБС (ДИТ г.Москвы)	Имя интеграции
controller	string		Контроллер сервиса
host*	string	example: https://10.23.64.140	IP-адрес или хост сервиса с указанием протокола (http:// или https://)
authHost	string	example: https://10.23.64.140	IP-адрес или хост для авторизации с указанием протокола (http:// или https://)
authPort*	number	example: 30415	Порт для аутентификации
apiPort*	number	example: 30417	Порт для API
basePath	string	example: /v1	Базовый путь
authBasePath	string	example: /v1	Базовый путь для авторизации
clientId*	string	example: rub-test	Идентификатор клиента
clientSecret*	string	example: 1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0	Секретное значение клиента
username*	string	example: rub-test	Имя пользователя для доступа к сервису
password*	string	example: 1AAbgZ9zmwIgo3Hwa8B	Пароль для доступа к сервису
kafkaBroker*	string	example: 10.23.64.142:31133	Адрес и порт Kafka-брокера
kafkaTopic	string	example: ebs_event_rub	Имя топика Kafka для событий биометрии
active	boolean		Состояние сервиса (включен/выключен)

Пример:

URL запроса: PUT

https://{IP_контроллера}/api/v1/biometry_services/dit/{id}

Body

{
  "uuid": "string",
  "name": "РС ЕБС (ДИТ г.Москвы)",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "authPort": 30415,
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

Пример с исправленным синтаксисом JSON

Добавлена закрывающая фигурная скобка.

{
  "success": false,
  "message": "string",
  "data": {}
}

Исходный пример Teamly

Пример из Teamly сохранён дословно, но не является корректным JSON.

{
  "success": false,
  "message": "string",
  "data": {}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 404 (Specified service does not exist) - запрос не выполнен, указанный сервис не существует

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Обновить сервис ДИТ в базе данных",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "description": "Конфигурация сервиса ДИТ в базе данных",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "uuid",
            "host",
            "clientId",
            "clientSecret",
            "username",
            "password",
            "kafkaBroker"
          ],
          "properties": {
            "uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "name": {
              "type": "string",
              "example": "РС ЕБС (ДИТ г.Москвы)"
            },
            "controller": {
              "type": "string"
            },
            "host": {
              "type": "string",
              "description": "IP-адрес или хост сервиса с указанием протокола (http:// или https://).",
              "example": "https://10.23.64.140"
            },
            "authHost": {
              "type": "string",
              "description": "IP-адрес или хост для авторизации с указанием протокола (http:// или https://).",
              "example": "https://10.23.64.140"
            },
            "clientId": {
              "type": "string",
              "description": "Идентификатор клиента.",
              "example": "rub-test"
            },
            "clientSecret": {
              "type": "string",
              "description": "Секрет клиента.",
              "example": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0"
            },
            "username": {
              "type": "string",
              "description": "Имя пользователя для доступа к сервису.",
              "example": "rub-test"
            },
            "password": {
              "type": "string",
              "description": "Пароль для доступа к сервису.",
              "example": "xEEXtsRE%7B%5B7bCEy"
            },
            "kafkaBroker": {
              "type": "string",
              "description": "Адрес и порт Kafka-брокера.",
              "example": "10.23.64.142:31133"
            },
            "kafkaTopic": {
              "type": "string",
              "description": "Имя топика Kafka для событий биометрии.",
              "example": "ebs_event_rub"
            },
            "active": {
              "type": "boolean",
              "description": "Включен/выключен"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Сервис обновлен",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Указанный сервис не существует",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "name": "РС ЕБС (ДИТ г.Москвы)",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}'

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

{
  "uuid": "string",
  "name": "РС ЕБС (ДИТ г.Москвы)",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}

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

{
  "success": false,
  "message": "string",
  "data": {}
}

`PATCH /biometry_services/dit/{id}`

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

Обновляет изменения сервиса ДИТ в базе данных

Источник в Teamly

Назначение	URL запроса
Обновить изменения сервиса ДИТ в базе данных	https://{IP_контроллера}/api/v1/biometry_services/dit/{id}

Параметры запроса:

Название	Тип	Описание
id*	string (path)	Уникальный идентификатор
BODY
Название * - обязательный	Тип	Формат	Назначение
uuid*	string	pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$	Уникальный идентификатор интеграции
name	string	example: РС ЕБС (ДИТ г.Москвы)	Имя интеграции
controller	string		Контроллер сервиса
host*	string	example: https://10.23.64.140	IP-адрес или хост сервиса с указанием протокола (http:// или https://)
authHost	string	example: https://10.23.64.140	IP-адрес или хост для авторизации с указанием протокола (http:// или https://)
authPort*	number	example: 30415	Порт для аутентификации
apiPort*	number	example: 30417	Порт для API
basePath	string	example: /v1	Базовый путь
authBasePath	string	example: /v1	Базовый путь для авторизации
clientId*	string	example: rub-test	Идентификатор клиента
clientSecret*	string	example: 1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0	Секретное значение клиента
username*	string	example: rub-test	Имя пользователя для доступа к сервису
password*	string	example: 1AAbgZ9zmwIgo3Hwa8B	Пароль для доступа к сервису
kafkaBroker*	string	example: 10.23.64.142:31133	Адрес и порт Kafka-брокера
kafkaTopic	string	example: ebs_event_rub	Имя топика Kafka для событий биометрии
active	boolean		Состояние сервиса (включен/выключен)

Пример:

URL запроса: PATCH
https://{IP_контроллера}/api/v1/biometry_services/dit/{id}

Body

{
  "uuid": "string",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "authPort": 30415,
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 404 (Specified service does not exist) - запрос не выполнен, указанный сервис не существует

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Обновить изменения сервиса ДИТ в базе данных",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "description": "Конфигурация сервиса ДИТ в базе данных",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "uuid": {
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[089abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            },
            "controller": {
              "type": "string"
            },
            "host": {
              "type": "string",
              "description": "IP-адрес или хост сервиса с указанием протокола (http:// или https://).",
              "example": "https://10.23.64.140"
            },
            "authHost": {
              "type": "string",
              "description": "IP-адрес или хост для авторизации с указанием протокола (http:// или https://).",
              "example": "https://10.23.64.140"
            },
            "clientId": {
              "type": "string",
              "description": "Идентификатор клиента.",
              "example": "rub-test"
            },
            "clientSecret": {
              "type": "string",
              "description": "Секрет клиента.",
              "example": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0"
            },
            "username": {
              "type": "string",
              "description": "Имя пользователя для доступа к сервису.",
              "example": "rub-test"
            },
            "password": {
              "type": "string",
              "description": "Пароль для доступа к сервису.",
              "example": "xEEXtsRE%7B%5B7bCEy"
            },
            "kafkaBroker": {
              "type": "string",
              "description": "Адрес и порт Kafka-брокера.",
              "example": "10.23.64.142:31133"
            },
            "kafkaTopic": {
              "type": "string",
              "description": "Имя топика Kafka для событий биометрии.",
              "example": "ebs_event_rub"
            },
            "active": {
              "type": "boolean",
              "description": "Включен/выключен"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Сервис обновлен",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Указанный сервис не существует",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

curl -k -X PATCH "https://{IP_контроллера}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "uuid": "string",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}'

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

{
  "uuid": "string",
  "controller": "string",
  "host": "https://10.23.64.140",
  "authHost": "https://10.23.64.140",
  "clientId": "rub-test",
  "clientSecret": "1AAbgZ9zmwIgo3Hwa8BmvyBx3XbZpvQ0",
  "username": "rub-test",
  "password": "xEEXtsRE%7B%5B7bCEy",
  "kafkaBroker": "10.23.64.142:31133",
  "kafkaTopic": "ebs_event_rub",
  "active": true
}

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

{
  "success": false,
  "message": "string",
  "data": {}
}

`DELETE /biometry_services/dit/{id}`

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

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

Источник в Teamly

Назначение	URL запроса
Позволяет удалить сервис биометрии	https://{IP_контроллера}/api/v1/biometry_services/dit/{id}

Параметры запроса:

Наименование, * - обязательный	Описание
id* string (path)	Уникальный идентификатор

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 404 (Service with specified id was not found) - запрос не выполнен, указанный сервис не найден

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Удалить сервис биометрии",
  "parameters": [
    {
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Сервис биометрии успешно удален",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Неверный запрос",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "404": {
      "description": "Сервис биометрии не существует",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Что-то пошло не так. Похоже, на сервере ошибка",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

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

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

{
  "success": false,
  "message": "string",
  "data": {}
}

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

GET /biometry_services/dit​

Примеры по OpenAPI​

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

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

POST /biometry_services/dit​

Примеры по OpenAPI​

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

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

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

GET /biometry_services/dit/access_point​

Примеры по OpenAPI​

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

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

POST /biometry_services/dit/access_point​

Примеры по OpenAPI​

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

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

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

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

Примеры по OpenAPI​

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

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

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

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

Примеры по OpenAPI​

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

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

PUT /biometry_services/dit/{id}​

Примеры по OpenAPI​

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

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

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

PATCH /biometry_services/dit/{id}​

Примеры по OpenAPI​

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

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

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

DELETE /biometry_services/dit/{id}​

Примеры по OpenAPI​

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

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

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

`GET /biometry_services/dit`

Примеры по OpenAPI

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

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

`POST /biometry_services/dit`

Примеры по OpenAPI

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

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

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

`GET /biometry_services/dit/access_point`

Примеры по OpenAPI

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

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

`POST /biometry_services/dit/access_point`

Примеры по OpenAPI

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

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

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

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

Примеры по OpenAPI

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

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

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

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

Примеры по OpenAPI

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

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

`PUT /biometry_services/dit/{id}`

Примеры по OpenAPI

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

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

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

`PATCH /biometry_services/dit/{id}`

Примеры по OpenAPI

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

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

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

`DELETE /biometry_services/dit/{id}`

Примеры по OpenAPI

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

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