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

Объекты системы

PreviousИспользование вебхуков для получения результатовNextРоли пользователей

Last updated 1 year ago

Was this helpful?

Иерархия объектов

Объекты системы имеют иерархическую структуру подчинения.

  1. На верхнем уровне находится Компания. Это значит, что один экземпляр установки Oz API может обслуживать пользователей нескольких не зависящих друг от друга компаний.

Поля объектов

Каждый объект имеет набор полей для работы и идентификации на уровне REST API запросов.

Общие поля

Поле

Тип

Описание

time_created

Timestamp

время создания объекта (кроме пользователя и компании)

time_updated

Timestamp

время изменения объекта

meta_data

Json

technical_meta_data

Json

технические поля, зарезервированные для работы модулей

Объект Компания

Поле

Тип

Описание

company_id

UUID

код компании в системе

name

String

наименование компании в системе

Объект Пользователь

Поле

Тип

Описание

user_id

UUID

код пользователя в системе

user_type

String

first_name

String

имя

last_name

String

фамилия

middle_name

String

отчество

email

String

email, который является логином пользователя

password

String

can_start_analyze_*

String

company_id

UUID

код компании пользователя

is_admin

Boolean

is_service

Boolean

Объект Папка

Поле

Тип

Описание

folder_id

UUID

код папки в системе

resolution_status

ResolutionStatus

Объект Медиа

Поле

Тип

Описание

media_id

UUID

код медиа

original_name

String

оригинальное имя файла (в файловой системе клиента)

original_url

Url

HTTP-ссылка на файл на сервере API

tags

Array(String)

Объект Анализ

Поле

Тип

Описание

analyse_id

UUID

код анализа

folder_id

UUID

код папки

type

String

results_data

Json

данные результата анализа

Пользователь является инициатором любого запроса. В зависимости от пользователя могут присутствовать определенные ограничения на те или иные действия.

При выполнении Пользователем запроса на Анализ система автоматически создает Папку, помещает туда все отправленные пользователем Медиафайлы, а затем запускает собственно (один или несколько). Анализы применяются к медиафайлам из папки в соответствии с . Требования к медиафайлам перечислены .

любые

пароль, указывается при добавлении нового пользователя или при изменении пароля. Если пользователя не admin, необходимо указать поле password_old

см.

статус последнего папки

список для этого файла

(BIOMETRY\QUALITY\DOCUMENTS)

роли
Анализ
Правилами назначения анализов
здесь
пользовательские поля
роль пользователя в системе
роль
роли пользователей
флаг админа
флаг сервисного пользователя
анализа
тегов
тип анализа