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

Usando o contêiner de dados OzCapsula no Web SDK

Neste modo, o SDK captura mídia do usuário, empacota todos os dados biométricos e técnicos em um contêiner (application/octet-stream), e então, ou:

  • faz o upload diretamente para Oz API (arquitetura: normal para API com estado ou lite para Instant), ou

  • o retorna ao seu backend para encaminhamento (captura arquitetura).

OzCapsula no Web SDK requer API 6.6.1 ou superior.

Visão geral da configuração

Ao ativar o modo contêiner, os principais parâmetros são:

Parâmetro

Valor

Descrição

use_wasm_container

true

Ativa a geração do contêiner de dados

architecture

normal / lite/ captura

Define quem envia os dados para Oz API (Web SDK ou seu backend)

api_use_session_token

api / client

Define quem recupera o token de sessão (Web SDK ou seu backend)

Token de sessão

api_use_session_token: "client"

Neste modo, seu backend obtém o token de sessão antes de abrir o Web SDK.

Etapas:

  1. Solicite um token de sessão de Oz API:

curl --location '{{host}}/api/authorize/session_token' \\
  -H 'X-Forensic-Access-Token: <YOUR_TOKEN>'
  1. A resposta conterá um token de sessão de curta duração session_token:

  1. Passe este token para o plugin do Web SDK:

O token de sessão é válido apenas por alguns minutos e deve ser solicitado antes de cada sessão de captura.

api_use_session_token: "api"

Este modo destina-se apenas a desenvolvimento e testes. Para ambientes de produção, use api_use_session_token: "client".

Neste modo, o SDK obtém automaticamente o token de sessão diretamente de Oz API. Não é necessário solicitá-lo nem fornecê-lo manualmente.

Fluxo para diferentes arquiteturas

O fluxo é diferente dependendo do tipo de arquitetura.

architecture: "normal"

Neste modo, o Web SDK faz upload automaticamente o contêiner gerado para Oz API. Você não precisa lidar com qualquer upload manualmente.

architecture: "lite"

Neste modo, o Web SDK faz upload automaticamente o contêiner gerado para Oz API. Você não precisa lidar com qualquer upload manualmente.

architecture: "capture"

Neste modo, o Web SDK apenas captura e empacota dados, mas não o envia para Oz API.

Seu backend é responsável por receber o contêiner e encaminhá-lo para Oz API.

Fluxo:

  1. O Web SDK realiza a captura de vídeo e chama o on_capture_complete(result, container) callback, em que o segundo argumento (contêiner) é um Blob objeto (application/octet-stream).

  2. Você envia este blob para o seu backend.

  3. Seu backend o envia para Oz API usando uma solicitação POST HTTPS.

Observe: atualmente, o contêiner funciona com modo de solicitação única apenas.

Exemplo de solicitação:

A resposta será semelhante à do fluxo sem contêiner.

Possíveis erros

Error

Descrição

error_wasm_internal_failure_1

O dispositivo ou navegador usado não é compatível com WASM

error_wasm_internal_failure_2

O dispositivo não tem memória suficiente para prosseguir

  • error_wasm_internal_failure_3

  • error_wasm_internal_failure_4

  • error_wasm_internal_failure_5

O SDK não conseguiu gerar o contêiner. Tente novamente

error_wasm_internal_failure_1000

Qualquer outro erro não listado acima

Atualizado

Isto foi útil?