Документация API#
Данный раздел содержит информацию о спецификациях OpenAPI для LUNA PLATFORM, LUNA Index Module, LUNA Vector Search Module и LUNA Vinder Module. Инженерам и программистам следует ознакомиться с этими документами, чтобы узнать о функциях и их реализации.
Эти документы:
- содержат текущую версию API;
- предоставляют информацию о доступных ресурсах, методах и параметрах;
- описывают необходимые входные данные;
- дают пояснение к каждому полю;
- приводят примеры тел запросов и ответов.
Взаимодействие с сервисами LUNA PLATFORM обеспечивается за счёт отправки HTTP-запросов.
Авторизация#
Почти все запросы, отправляемые в LP 5, требуют авторизации. В LUNA PLATFORM доступны следующие типы авторизации:
- BasicAuth. Авторизация по логину и паролю (задаются при создании аккаунта).
- BearerAuth. Авторизация с помощью JWT-токена (выдаётся после создания токена).
Примечание. Также в рамках обратной совместимости с предыдущими версиями LUNA PLATFORM доступна авторизация LunaAccountIdAuth. Не рекомендуется использовать данный тип авторизации в новых проектах; по умолчанию он отключён.
Нет необходимости использовать все три типа авторизации при отправке запросов. Выберите предпочтительный метод в зависимости от требуемых задач.
Для того чтобы воспользоваться одним из видов авторизации, необходимо иметь аккаунт. Аккаунт создаётся с помощью POST-запроса create account к сервису API, POST-запроса register account к сервису Admin или с помощью графического интерфейса Admin.
Если в запросе не указан тип авторизации, будет возвращена ошибка с кодом состояния 403.
Подробную информацию об учётных записях см. в разделе "Аккаунты, токены и способы авторизации" руководства администратора.
Спецификации OpenAPI#
На русском языке доступна только спецификация OpenAPI для сервиса API LUNA PLATFORM. Все остальные спецификации (для других сервисов LUNA PLATFORM, а также для LUNA Index Module, LUNA Vector Search Module и LUNA Vinder Module) представлены на английском языке (см. таблицы ниже).
Спецификации OpenAPI предоставляются в двух форматах: HTML и YML.
- Документ в формате HTML предоставляет визуальное представление спецификации API и может быть неполным.
- Документы в формате YML содержат полноценные, пригодные к импорту спецификации. Вы можете импортировать файл во внешнее приложение для создания запросов (например, Postman) или визуализировать его с помощью специальных инструментов (например, https://editor.swagger.io/).
HTML и YML-документы, соответствующие одному и тому же сервису, имеют одинаковые названия (отличаются только расширением).
Спецификации OpenAPI для LP#
В таблице ниже приведены ссылки на спецификации OpenAPI, представленные в формате HTML.
| Имя документа | Описание | Ссылка на документ в формате HTML |
|---|---|---|
| Спецификация сервиса API | Общие запросы к сервису API (на русском языке) | APIReferenceManual |
| Спецификация сервиса Sender | Подписка на события по протоколу WebSocket | SenderReferenceManual |
| Спецификация сервиса Admin | Запросы, связанные с административными процедурами | AdminReferenceManual |
| Спецификация сервиса Configurator | Запросы для управления сущностями Configurator | ConfiguratorReferenceManual |
| Спецификация сервиса Faces | Запросы, связанные с лицами, списками и атрибутами | FacesReferenceManual |
| Спецификация сервиса Tasks | Запросы, связанные с длительными задачами | TasksReferenceManual |
| Спецификация сервиса Handlers | Запросы, связанные с обработчиками | HandlersReferenceManual |
| Спецификация сервиса Remote SDK | Запросы, связанные с детекцией и оценкой | RemoteSDKReferenceManual |
| Спецификация сервиса Events | Запросы, связанные с событиями | EventsReferenceManual |
| Спецификация сервиса Image Store | Запросы, связанные с хранением данных в Image Store | ImageStoreReferenceManual |
| Спецификация сервиса Python Matcher | Запросы, связанные с матчингом | PythonMatcherReferenceManual |
| Спецификация сервиса Accounts | Запросы, связанные с учётными записями | AccountsReferenceManual |
| Спецификация сервиса Licenses | Запросы, связанные с лицензированием | LicensesReferenceManual |
| Спецификация сервиса Lambda | Запросы, связанные с управлением lambda | LambdaReferenceManual |
| Спецификация сервиса Builder | Запросы, связанные со сборкой Docker-образов | BuilderReferenceManual |
| Спецификация сервиса Serving | Запросы, связанные с внешними сервисами | ServingReferenceManual |
| Спецификация сервиса Video Manager | Запросы, связанные с управлением потоков | VideoManagerReferenceManual |
| Спецификация сервиса Video Agent | Запросы, связанные с Video Agent | VideoAgentReferenceManual |
Спецификация аналитики human tracking |
Запросы, связанные с аналитикой отслеживания людей | HumanTrackingReferenceManual |
Спецификация аналитики people count |
Запросы, связанные с аналитикой подсчёта людей | PeopleCountReferenceManual |
В таблице ниже приведены ссылки на спецификации OpenAPI, представленные в формате YML.
| Имя документа | Описание | Ссылка на документ в формате YML |
|---|---|---|
| Спецификация сервиса API | Общие запросы к сервису API (на русском языке) | APIReferenceManual |
| Спецификация сервиса Sender | Подписка на события по протоколу WebSocket | SenderReferenceManual |
| Спецификация сервиса Admin | Запросы, связанные с административными процедурами | AdminReferenceManual |
| Спецификация сервиса Configurator | Запросы для управления сущностями Configurator | ConfiguratorReferenceManual |
| Спецификация сервиса Faces | Запросы, связанные с лицами, списками и атрибутами | FacesReferenceManual |
| Спецификация сервиса Tasks | Запросы, связанные с длительными задачами | TasksReferenceManual |
| Спецификация сервиса Handlers | Запросы, связанные с обработчиками | HandlersReferenceManual |
| Спецификация сервиса Remote SDK | Запросы, связанные с детекцией и оценкой | RemoteSDKReferenceManual |
| Спецификация сервиса Events | Запросы, связанные с событиями | EventsReferenceManual |
| Спецификация сервиса Image Store | Запросы, связанные с хранением данных в Image Store | ImageStoreReferenceManual |
| Спецификация сервиса Python Matcher | Запросы, связанные с матчингом | PythonMatcherReferenceManual |
| Спецификация сервиса Accounts | Запросы, связанные с учётными записями | AccountsReferenceManual |
| Спецификация сервиса Licenses | Запросы, связанные с лицензированием | LicensesReferenceManual |
| Спецификация сервиса Lambda | Запросы, связанные с управлением lambda | LambdaReferenceManual |
| Спецификация сервиса Builder | Запросы, связанные со сборкой Docker-образов | BuilderReferenceManual |
| Спецификация сервиса Serving | Запросы, связанные с внешними сервисами | ServingReferenceManual |
| Спецификация сервиса Video Manager | Запросы, связанные с управлением потоков | VideoManagerReferenceManual |
| Спецификация сервиса Video Agent | Запросы, связанные с Video Agent | VideoAgentReferenceManual |
Спецификация аналитики human tracking |
Запросы, связанные с аналитикой отслеживания людей | HumanTrackingReferenceManual |
Спецификация аналитики people count |
Запросы, связанные с аналитикой подсчёта людей | PeopleCountReferenceManual |
Спецификации OpenAPI для LIM#
В таблице ниже приведены ссылки на спецификации OpenAPI, представленные в формате HTML.
| Имя документа | Описание | Ссылка на документ в формате HTML |
|---|---|---|
| Спецификация сервиса Index Manager | Запросы, связанные с задачами построения индексов и управлением сервиса Indexer | IndexManagerReferenceManual |
| Спецификация сервиса Indexer | Запросы, связанные с построением индексов | IndexerReferenceManual |
| Спецификация сервиса Indexed Matcher | Запросы, связанные со сравнением по индексам | IndexedMatcherReferenceManual |
В таблице ниже приведены ссылки на спецификации OpenAPI, представленные в формате YML.
| Имя документа | Описание | Ссылка на документ в формате YML |
|---|---|---|
| Спецификация сервиса Index Manager | Запросы, связанные с задачами построения индексов и управлением сервиса Indexer | IndexManagerReferenceManual |
| Спецификация сервиса Indexer | Запросы, связанные с построением индексов | IndexerReferenceManual |
| Спецификация сервиса Indexed Matcher | Запросы, связанные со сравнением по индексам | IndexedMatcherReferenceManual |
Спецификации OpenAPI для LVSM#
| Формат | Ссылка |
|---|---|
| HTML | LVSMReferenceManual |
| YML | LVSMReferenceManual |
Спецификации OpenAPI для LVM#
В таблице ниже приведены ссылки на спецификации OpenAPI, представленные в формате HTML.
| Имя документа | Описание | Ссылка на документ в формате HTML |
|---|---|---|
| Спецификация сервиса Projector | Запросы для создания проекций данных и управления ими | ProjectorReferenceManual |
| Спецификация сервиса Matcher | Запросы, связанные с построением индексов и сравнением на основе загруженных проекций | MatcherReferenceManual |
В таблице ниже приведены ссылки на спецификации OpenAPI, представленные в формате YML.
| Имя документа | Описание | Ссылка на документ в формате YML |
|---|---|---|
| Спецификация сервиса Projector | Запросы для создания проекций данных и управления ими | ProjectorReferenceManual |
| Спецификация сервиса Matcher | Запросы, связанные с построением индексов и сравнением на основе загруженных проекций | MatcherReferenceManual |