Oz API

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

• fornece a interface de API REST 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 versão 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 depois	Nada é armazenado – o resultado existe apenas na resposta HTTP
Melhor para	histórico de casos, Web Console, relatórios, webhooks, reanálise	dados sensíveis, conformidade com GDPR, uma ocupação mínima de armazenamento

Instant API faz parte do Oz API, não é um produto separado: 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 multi-requisição

Você pode 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.

• Multi-requisição – crie a pasta, envie a mídia, atribua as análises e então consulte periodicamente o resultado ou receba-o via um webhook. Use isto para mídia maior, análise diferida ou revisão por operador.

Captura segura do OzCapsula

Para proteção máxima da mídia capturada, os SDKs do 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 para a API exatamente 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 ao Oz API são autorizadas com um token passado no X-Forensic-Access-Token cabeçalho. Ele é obtido ao entrar com credenciais ou ao usar um token de serviço para integrações servidor a servidor. Instant API pode, opcionalmente, ser executado sem autorização.