For the complete documentation index, see llms.txt. This page is also available as Markdown.

Oz API

Oz API é o componente mais importante do sistema – conecta todos os outros componentes entre si e é a interface REST unificada que você chama para executar Liveness e Biometry análises. Oz API:

  • fornece a interface REST API unificada para executar as análises de Liveness e Biometry,

  • processa a autorização e o gerenciamento de permissões de usuário,

  • rastreia e registra os pedidos e análises solicitados no banco de dados (por exemplo, na 6.0 o tamanho do banco de dados para 100 000 pedidos com análises é de ~4 GB),

  • arquiva os arquivos de mídia recebidos,

  • coleta telemetria dos aplicativos móveis conectados,

  • fornece configurações para modelos específicos de dispositivos,

  • gera relatórios com os resultados das análises.

Para a coleção mais recente de métodos da API, consulte nossa referência da API.

Modos persistente e não persistente (Instant)

Oz API executa as mesmas análises em dois modos que diferem principalmente em o que é armazenado:

Persistente (/api/folders/)

Não persistente – Instant API (/api/instant/folders/)

O que é armazenado

Cria uma pasta; mídia, análises, resultados e relatórios são armazenados e podem ser recuperados posteriormente

Nada é armazenado – o resultado existe apenas na resposta HTTP. No entanto, é possível configurar armazenamento em S3 para salvar os artefatos da Instant API.

Ideal para

Histórico do caso, Web Console, relatórios, webhooks, reanálise

Dados sensíveis, conformidade com GDPR, um uso mínimo de armazenamento

Instant API faz parte da Oz API, não é um produto separado: ela expõe as mesmas análises por meio de um endpoint não persistente e oferece suporte aos dois modos de envio descritos abaixo.

Requisição única e múltipla

É possível enviar sua mídia e análises de duas maneiras, disponíveis tanto nos modos persistente quanto Instant:

  • Requisição única – envie toda a mídia junto com a solicitação de análise em uma única chamada e receba os resultados na mesma resposta. Isso elimina a necessidade de várias chamadas à API – uma é suficiente. Introduzido na API 6.0.

  • Múltiplas requisições – crie a pasta, faça upload da mídia, atribua as análises e, em seguida, consulte o resultado periodicamente ou receba-o por meio de um webhook. Use isto para mídias maiores, análise adiada ou revisão por operador.

Captura segura do OzCapsula

Para máxima proteção da mídia capturada, os SDKs Oz podem empacotar uma captura em OzCapsula – um contêiner de dados proprietário, criptografado e protegido contra integridade, vinculado a uma única sessão de captura por um session_token. O contêiner é um blob opaco: ele é encaminhado à API como está (com Content-Type: application/octet-stream) e validado no lado do servidor, o que protege contra injeção, adulteração e repetição dos dados capturados.

Os contêineres OzCapsula são enviados atualmente somente via requisição única – seja em POST /api/folders/ (persistente) ou POST /api/instant/folders/ (Instant).

Autenticação

As chamadas da Oz API são autorizadas com um token passado no cabeçalho X-Forensic-Access-Token . Você o obtém ao fazer login com credenciais ou usando um token de serviço de longa duração para integrações servidor a servidor. A Instant API pode ser executada opcionalmente sem autorização.

Atualizado

Isto foi útil?