Conceitos-chave da Oz API

A Oz API é uma API REST abrangente que habilita biometria facial, permitindo tanto correspondência facial quanto verificações de Liveness. Este texto fornece uma visão geral dos conceitos essenciais que devem ser mantidos em mente ao usar a Oz API.

Autenticação, funções e gerenciamento de acesso

Para garantir a segurança, toda chamada à Oz API requer um token de acesso em seus cabeçalhos HTTP. Para obter esse token, execute o POST /api/authorize/auth método com login e senha fornecidos por nós. Passe esse token no X-Forensic-Access-Token cabeçalho nas chamadas subsequentes à Oz API.

Este artigo fornece detalhes abrangentes sobre o processo de autenticação. Consulte-o para mais informações.

Além disso, a Oz API oferece funções de usuário distintas, variando de CLIENT, que pode executar verificações e acessar relatórios, mas não possui direitos administrativos, por exemplo, excluir pastas, até ADMIN, que desfruta de acesso quase irrestrito a todos os objetos do sistema. Para mais informações, consulte este guia.

Persistência

A unidade de trabalho na Oz API é uma folder: você pode carregar mídias inter-relacionadas para uma pasta, executar análises sobre elas e verificar o resultado agregado. Uma pasta pode conter um número ilimitado de mídias, e cada mídia pode ser alvo de várias análises. Além disso, análises podem ser executadas em um conjunto de mídias.

Tipos de mídia e tags

A Oz API trabalha com fotos e vídeos. Um vídeo pode ser tanto um contêiner de vídeo regular, por exemplo, MP4 ou MOV, quanto um arquivo ZIP com uma sequência de imagens. A Oz API usa o tipo MIME do arquivo para definir se a mídia é uma imagem, um vídeo ou um conjunto de capturas.

Também é importante determinar a semântica de um conteúdo, por exemplo, se uma imagem é a foto de um documento ou uma selfie de uma pessoa. Isso é alcançado por meio do uso de tags. A seleção de tags influencia se tipos específicos de análises reconhecerão ou ignorarão arquivos de mídia específicos. As tags mais importantes são:

• photo_id_front – para o lado frontal de um documento de identidade com foto

• photo_selfie – para uma foto de referência que não seja de documento

• video_selfie_blank – para um vídeo de Liveness gravado fora do Oz Liveness SDK

• se um arquivo de mídia for capturado usando o Oz Liveness SDK, as tags são atribuídas automaticamente.

A lista completa das tags de mídia da Oz com suas explicações e exemplos pode ser encontrada aqui.

Análises assíncronas

Como a análise de vídeo pode levar alguns segundos, as análises são executadas de forma assíncrona. Isso implica que você inicia uma análise (/api/folders/{{folder_id}}/analyses/) e então monitora os resultados por polling até que o processamento seja concluído (/api/analyses/{{analysis_id}} para uma única análise ou /api/folders/{{folder_id}}/analyses/ para todas as análises da pasta). Como alternativa, há uma opção de webhook disponível. Para ver um exemplo de como usar as opções de polling e webhook, consulte este guia.

Estes foram os conceitos-chave da Oz API. Para obter uma compreensão mais profunda de suas capacidades, consulte a seção da Oz API do nosso guia do desenvolvedor.