Персоны

Работа с методами API управления записями персон#

Warning

Для использования методов необходимо использовать токен авторизации. Методы доступны только при использовании токена. В качестве авторизации используется Auth: HTTPBearer, то есть будет выдан токен UUID4, который нужно будет использовать при использовании описанных выше методов.

API управления записями персон включает в себя следующие методы:

Создание записи персоны
Редактирование записи персоны
Выгрузка списка всех персон
Добавление изображений к конкретной персоне
Получение информации о конкретной персоне по её идентификатору
Удаление записи персоны по уникальному идентификатору
Получение изображения конкретной персоны по идентификатору
Удаление изображения конкретной персоны по уникальному идентификатору

1. Создание записи персоны#

POST /v1/persons - это метод, который позволяет добавить в Систему новую персону. В запросе два обязательных поля: images - изображения персоны и name - имя персоны. И необязательное поле description - дополнительное описание.

Ограничения:

К пользователю можно добавить только 10 изображений
На каждом изображении должно быть только 1 лицо
Размер лица на изображении должен быть больше 244x224 пикселей

В случае успешного создания записи персоны вернется ответ вида:

{
  "id": "123",
  "name": "Иван Иванович Иванов",
  "description": "Менеджер по продажам",
  "creation_date": "2023-06-15T13:45:59.227Z",
  "images": [
    "string"
  ]
}

При ошибке создания записи персоны ответ будет выглядеть следующим образом:

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

2. Редактирование записи персоны#

PUT /v1/persons - это метод, который используется для обновления информации о существующей персоне. Данный запрос выполняет операцию обновления (PUT), которая изменяет данные персоны в системе. Три поля в теле запроса:

person_id - идентификатор персоны, информация о котором требует изменений
name - имя персоны
description - описание

3. Выгрузка списка всех персон#

GET /v1/persons - это метод, который используется для получения списка персон. Данный запрос выполняет операцию чтения (GET), которая возвращает информацию о всех имеющихся в системе персонах.

4. Добавление изображений к конкретной персоне#

POST /v1/persons/{person_id}/images - это метод, который используется для добавления изображений к конкретной персоне. Этот запрос выполняет операцию создания нового изображения, связанного с указанной персоной.

Параметр запроса person_id - идентификатор персоны

Тело запроса должно содержать изображение images, которое необходимо добавить.

5. Получение информации о конкретной персоне по её идентификатору#

GET /v1/persons/{person_id} - это метод, который используется для получения информации о конкретной персоне по её идентификатору (person_id).

6. Удаление записи персоны по уникальному идентификатору#

DELETE /v1/persons/{person_id} - это путь в API NV Biometry, который используется для удаления конкретной персоне по её идентификатору (person_id).

Параметры person_id - это идентификатор персоны, информацию о которой нужно удалить.

7. Получение изображения конкретной персоны по идентификатору#

GET /v1/persons/{person_id}/images/{image_id} - это метод, который используется для получения информации о конкретном изображении, связанном с определенной персоной.

Параметры:

person_id - идентификатор персоны.
image_id - идентификатор изображения.

8. Удаление изображения конкретной персоны по уникальному идентификатору#

DELETE /v1/persons/{person_id}/images/{image_id} - это метод, который используется для удаления конкретного изображения, связанного с определенной персоной.

Параметры:

{person_id} - идентификатор персоны.
{image_id} - идентификатор изображения.