LogoLogo
Switch to EnglishНа сайт Oz ForensicsOz APIСвязаться с нами
  • Общая информация
    • Описание системы Oz Forensics
      • Архитектура Oz
      • Проверки Liveness, Face Matching, Black List
      • Oz API и Oz API Lite
      • Пассивный и активный Liveness
      • Гибридный Liveness
      • Ключевые понятия Oz API
      • Модели использования: SaaS, локальная установка и анализ на устройстве
      • Варианты лицензирования
    • Краткие руководства по интеграции
      • Проверка Liveness на сервере
        • Как интегрировать серверную проверку Liveness в ваше Web-приложение
        • Как интегрировать серверную проверку Liveness в ваше мобильное приложение
        • Как провести проверку медиафайла на Liveness без использования фронтенда Oz
      • Проверка Liveness на устройстве
        • Как интегрировать проверку Liveness на устройстве в ваше мобильное приложение
      • Сравнение лиц
        • Как сравнить лицо из снятого для проверки Liveness видео с лицом из вашей базы данных
        • Как добавить съемку документа и возможность сопоставления лиц в ваше веб- или мобильное приложение
  • Руководства
    • Руководство разработчика
      • API
        • Oz API
          • Как работать с системой: базовые сценарии
            • Аутентификация
            • Загрузка медиафайлов
            • Liveness
            • Биометрия
            • Поиск лучшего кадра
            • Проверка по черному списку
              • Работа с черным списком (коллекцией) в Oz API
            • Результаты анализов
            • Использование вебхуков для получения результатов
          • Объекты системы
          • Роли пользователей
          • Типы анализов и что они проверяют
          • Правила назначения анализов
          • Статусы API
          • Теги медиафайлов
          • Метаданные
          • Ошибки вызова сервиса
          • Коллекции Postman Oz API
          • Журнал изменений
        • Oz API Lite
          • Методы API Lite
          • Коллекция Postman Oz API Lite
          • Журнал изменений
      • SDK
        • Oz Mobile SDK (iOS, Android, Flutter)
          • Выполнение анализов на устройстве
          • Android
            • Получение лицензии
              • Мастер-лицензия для Android
            • Добавление SDK в проект
            • Подключение к API
            • Съемка видео
            • Выполнение проверок
            • Настройка Android SDK
              • Прежний дизайн
            • Локализация для Android: добавление или обновление языкового пакета
            • Методы и поля Android SDK
            • Журнал изменений
          • iOS
            • Получение лицензии
              • Мастер-лицензия для iOS
            • Добавление SDK в приложение
            • Подключение к API
            • Съемка видео
            • Выполнение проверок
            • Настройка iOS SDK
              • Прежний дизайн
            • Локализация для iOS: добавление или обновление языкового пакета
            • Методы и поля iOS SDK
            • Журнал изменений
          • Flutter
            • Установка и использование плагина для Flutter
            • Журнал изменений
        • Oz Liveness Web SDK
          • Web Plugin
            • Добавление плагина на web-страницу
            • Запуск плагина
              • Описание коллбэка on_complete
              • Описание коллбэка on_result
              • Съемка видео и описание коллбэка on_capture_complete
              • Описание коллбэка on_error
            • Скрытие и закрытие плагина
            • Локализация: добавление собственного языкового пакета
            • Настройка интерфейса
              • Настройка интерфейса до версии 1.0.1
            • Рекомендации по безопасности
            • Совместимость с браузерами
            • Лицензирование без использования сервера
          • Журнал изменений
    • Руководство администратора
      • Сервер лицензий
      • Конфигурация Web Adapter
        • Установка и лицензирование
        • Настройки файла конфигурации
        • Настройка Web Adapter через переменные окружения
        • Настройка сервера через переменные окружения
      • Конфигурация API
    • Руководство пользователя
      • Oz Web UI
        • Заявка на анализ
        • Пользователи и компании
        • Черный список
        • Статистика
        • Настройки
        • Журнал изменений
  • Дополнительная информация
    • Обновление ПО в соответствии с новыми требованиями регулятора в Казахстане
    • Требования к качеству медиафайлов
    • Какие проверки выполняют Oz SDK при съемке
    • Размеры медиафайлов, снятых Oz SDK
    • Совместимость
    • FAQ
    • Советы и рекомендации
      • Sudo без пароля
      • Соответствие жестов в компонентах Oz Liveness
      • Android: ошибка валидации сертификата
    • Прежняя версия документации
      • Mobile SDK
        • Android
          • Работа с серверным Oz API
          • Выполнение проверок
        • iOS
          • Выполнение проверок
      • Руководство пользователя
        • Демо-версия приложения Oz Forensics
        • Web UI
      • Мониторинг
      • Установка модулей Oz
        • Стационарный установщик
        • Oz System Lite
Powered by GitBook
On this page
  • Аутентификация пользователя
  • Автопродление сессий
  • Обновление токенов
  • Возможные ошибки

Was this helpful?

Export as PDF
  1. Руководства
  2. Руководство разработчика
  3. API
  4. Oz API
  5. Как работать с системой: базовые сценарии

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

Как получить и обновить токены доступа.

PreviousКак работать с системой: базовые сценарииNextЗагрузка медиафайлов

Last updated 1 year ago

Was this helpful?

Аутентификация пользователя

Чтобы получить токены доступа, нужно выполнить POST-запрос на /authorize/auth/. В теле запроса нужно указать полученные от нас электронную почту и пароль в составе credentials, а также API-адрес в качестве адреса хоста.

Body

{
	"credentials": {
		"email": "{{user_email}}",
		"password": "{{user_password}}"
	}
}

Результатом аутентификации пользователя является пара access_token и expire_token.

access_token – ключ (набор символов), предъявление которого является пропуском к ресурсам системы. Обращение к ним происходит с указанием в заголовках полученного access_token.

headers = {‘ X-Forensic-Access-Token’: <access_token>}

Действие access_token ограничено во времени и регулируется :

  • для сервисных учетных записей – OZ_SESSION_LONGLIVE_TTL (по умолчанию 5 лет),

  • для всех остальных – OZ_SESSION_TTL (по умолчанию 15 минут).

expire_token предназначен для обновления пары access_token и expire_token.

Автопродление сессий

если expire_date > текущей даты, то expire_date сессии устанавливается в значение текущей даты + временная дельта настроек, описанных выше.

Обновление токенов

Чтобы обновить пару access_token и expire_token, нужно выполнить POST-запрос на адрес authorize/refresh/ c expire_token в теле запроса и X-Forensic-Access-Token в заголовках.

{
    "expire_token": "{{expire_token}}"
}

Положительным результатом будет ответ с новой парой access_token и expire_token. Предыдущая пара access_token и expire_token будет удалена из базы данных при первой аутентификации по новой паре access_token и expire_token.

Возможные ошибки

Код ошибки

Сообщение об ошибке

Причина

400

Could not locate field for key_path expire_token from provided dict data

expire_token отсутствует в теле запроса.

401

Session not found

Не существует сессии с переданным expire_token.

403

You have not access to refresh this session

Пользователь, который делает запрос, не является владельцем сессии переданного expire_token.

настройками