API

FindFace Lite API находится на странице http:// <your_hostname>/api-docs. Страница интерактивна, вы можете делать запросы и получать ответы прямо на ней.

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

В этой статье описаны функциональность FindFace Lite API и то, как использовать интерактивную API документацию.

Подготовка к использованию API

Перед использованием FindFace Lite API выполните авторизацию, создав JWT-токен в разделе AUTHENTICATION.

Введите username и password из ШАГА 5 блока С чего начать и нажмите кнопку SET TOKEN.

_images/authentification.png

После аутентификации можно начать использование интерактивной FindFace Lite API.

Примечание

Для применения API запросов вне интерактивной API документации используйте сгенерированный токен.

Использование API

Страница с API разделена на 2 части: слева список операций, справа поля для выполнения операции.

_images/api.png

Каждая операция содержит блок Request и блок Response:

  • Блок Request описывает операции, включая request schema — структуру запроса с интерпретацией каждого параметра, request example — пример запроса и кнопку TRY для отправки запроса.

_images/request.png

  • Блок Response описывает schema — структуру ответа и examples — примеры каждого варианта ответа для используемой операции.

_images/response_ex.png

После нажатия кнопки TRY запрос отправится, отобразится блок ответа с response status — статусом запроса и подробной информацией о нем.

_images/response_status.png

Функциональность FindFace Lite API

API документацию можно разделить на смысловые блоки, которые содержат все доступные операции по управлению функциональностью FindFace Lite: получение, изменение и удаление сущностей.

  1. Процесс распознавания

    • Операции раздела Camera управляют объектом Camera, который является образом видеопотока или файла, передающего видео. Активный объект Camera получает информацию из обработчика видеопотоков VideoWorker и конвертирует ее в Event’ы.

    • Операции раздела Event управляют объектом Event, который является результатом фиксации лица или автомобиля, попадающего в кадр камеры. Активный объект Camera получает информацию из обработчика видеопотоков VideoWorker и конвертирует ее в Event’ы. Вы или сторонняя система также можете создавать их вне автоматического процесса, используя POST-запрос.

    • Операции раздела Card управляют объектом Card, который является профилем реального человека или автомобиля. Card может быть двух типов face или car.

    • Операции раздела Object управляют объектом Object, который соответствует реальному лицу или автомобилю. Чтобы создать объект необходимо добавить соответствующие изображение и ссылку на Card, к которому необходимо привязать Object.

    flow_full_ru

  2. Взаимодействие с внешними системами

    • Операции раздела Webhook управляют отправкой уведомлений о совпадении по Event во внешние системы.

  3. Аутентификация и настройки пользователя

    • Операции раздела Auth описывают методы для аутентификации.

    • Операции раздела User управляют пользователями FindFace Lite

  4. Системные операции

    • Раздел Misc содержат прочие запросы, связанные с работой сервиса.

    • Раздел Pipline – это внутренний метод для обработчика видеопотоков VideoWorker и обычно не используется в общем процессе.