Документация по API

Аутентификация
Работа с компаниями
OCR API
Биометрия API

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

Чтобы начать работу с API, необходимо зарегистрировать компанию аккаунт пользователя и компанию. После регистрации и пополнения баланса вашей компании будет выдан api_key_session, связанный с компанией.

1. Получение access_token:
Выполните POST-запрос на /token/refresh с телом:

{
    "api_key_session": "ваш api_key_session"
}

В ответ вы получите:

{
    "access_token": "...",
    "api_key_session": "..." // Обновляется каждый раз при запросе access_token
}

Access_token используется во всех защищённых API-запросах и имеет ограниченное время действия.

Работа с компаниями

Управление компаниями осуществляется через личный кабинет. Каждая компания имеет собственный api_key_session и историю операций. Только администратор может изменять статус, редактировать или удалять компанию. Удалённая компания автоматически блокирует все связанные сервисы.

OCR API (Сканирование документов)

API позволяет сторонним приложениям инициировать процесс сканирования ID-документов (удостоверение личности, паспорт и др.).

Как интегрировать:

Получите access_token с помощью вашего api_key_session (см. раздел "Аутентификация").
Сформируйте POST-запрос на /token/get-session со следующим телом:
```
    {
        "operation_type": "IDENTITY_CARD",
        "requested_formats": ["json"]
    }
```
и передайте ваш access_token в заголовке:
```
Authorization: Bearer <access_token>
```
В ответ вы получите session_token, который необходимо сохранить.
Сделайте редирект (или ссылку) пользователя на страницу:
```
/page/upload-form?session_token=<session_token>
```

После завершения процесса, результат операции будет отправлен на callback URL, который был зарегистрирован вашей компанией через администратора системы.

Также результаты можно просматривать вручную в личном кабинете зарегистрированной компании.

Биометрия API (Распознавание лица)

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

Как интегрировать:

Получите access_token с помощью вашего api_key_session.

Выполните POST-запрос на /token/get-session со следующим телом:

    {
        "operation_type": "FACIAL_BIOMETRICS",
        "requested_formats": ["json", "xml"]
    }

и заголовком:

Authorization: Bearer <access_token>

Получите session_token из ответа.
Сделайте редирект пользователя на URL загрузки:
```
/page/upload-form?session_token=<session_token>
```

После завершения биометрической верификации результат будет отправлен на callback URL, указанный вашей компанией. Вы должны реализовать собственный эндпоинт для приёма уведомлений (Webhook).

Как альтернатива — результаты можно просматривать вручную в личном кабинете вашей компании.