> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge-ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api.md).

# Oz API

<figure><img src="/files/BFAhtPZyTRCAjggwbamD" alt=""><figcaption></figcaption></figure>

## Oz API

Oz API — это наиболее важный компонент системы, который связывает между собой все остальные компоненты. Он представляет собой единый REST-интерфейс, используемый для запуска анализов **Liveness** и **Biometry**. Oz API:

* предоставляет единый REST API для запуска анализов Liveness и Biometry;
* выполняет авторизацию и управление правами доступа пользователей;
* отслеживает и сохраняет информацию о заявках и анализах в базе данных (например, в версии 6.0 база данных для 100 000 заказов с анализами занимает около \~4 ГБ);
* архивирует входящие медиафайлы;
* собирает телеметрию;
* предоставляет возможность настроить специфичные модели устройств;
* формирует отчеты с результатами анализов.

Актуальный список методов API приведен в разделе [API reference](https://apidoc.ozforensics.com/).

#### Режимы работы с сохранением (Full) и без сохранения (Instant) данных

Oz API работает с анализами в двух режимах, которые отличаются главным образом тем, **какие данные сохраняются**:

|                     | Full (`/api/folders/`)                                                                              | Instant API (`/api/instant/folders/`)                                                                 |
| ------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| **Что сохраняется** | Создается папка; медиафайлы, анализы, результаты и отчеты сохраняются и могут быть получены позднее | Ничего не сохраняется — результат присутствует только в HTTP-ответе                                   |
| **Подходит для**    | Ведения истории обращений, работы с Web Console, отчетов, проведения повторных анализов             | Работы с чувствительными данными, соответствия требованиям GDPR и минимизации использования хранилища |

Instant API является частью Oz API, а не отдельным продуктом. Он предоставляет те же самые анализы через отдельный endpoint и поддерживает оба режима отправки данных, описанные ниже.

#### Один запрос и несколько запросов

Передать медиафайлы и назначить на них анализ можно двумя способами:

* **Single request** — отправьте все медиафайлы вместе с запросом на выполнение анализа одним вызовом API и получите результат в том же ответе. Это избавляет от необходимости выполнять несколько последовательных вызовов API — достаточно одного. Возможность появилась в API 6.0.
* **Multi-request** — создайте папку, загрузите медиафайлы, назначьте анализы, а затем ожидайте результат путем опроса API или получите его через webhook.&#x20;

#### Съемка с помощью OzCapsula

Для максимальной защиты SDK могут упаковывать снятое видео и сопутствующие ему данные в контейнер **OzCapsula** — собственный зашифрованный контейнер с защитой целостности, привязанный к одной сессии захвата с помощью кратковременно действующего `session_token`.

Контейнер представляет собой бинарный объект (opaque blob): он передается в API без каких-либо изменений (с заголовком `Content-Type: application/octet-stream`) и проверяется на стороне сервера, что обеспечивает защиту от внедрения, подмены и повторного воспроизведения (replay) захваченных данных.

{% hint style="info" %}
Контейнеры OzCapsula в настоящее время можно отправлять **только через Single request** — либо на `POST /api/folders/` (Full API), либо на `POST /api/instant/folders/` (Instant API).
{% endhint %}

#### Аутентификация

Вызовы Oz API [авторизуются](/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/autentifikaciya-i-obrabotka-dannykh/tokens.md) с помощью токена, передаваемого в заголовке `X-Forensic-Access-Token`.

Получить этот токен можно:

* выполнив вход с использованием учетных данных;
* используя долгоживущий **service token** для серверных интеграций.

Instant API может работать и без авторизации.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.