Biometria Anviz
Esta seção agrupa os comandos para o gerenciamento completo do ciclo de vida das biometrias (digitais) no leitor Anviz do controlador MG3000. Os endpoints permitem consultar a capacidade de armazenamento, obter templates biométricos, encontrar IDs vagos para novos cadastros e realizar a vinculação ou remoção de digitais na memória do equipamento.
1. Obter Digital Não Cadastrada (por Instância)
Descrição:
Captura e retorna a imagem de uma digital recém-colocada no leitor biométrico Anviz, mas que ainda não foi salva ou vinculada a um usuário. Utiliza o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/fingerprints
Quando Usar:
No primeiro passo do processo de cadastro biométrico, para capturar a imagem da digital do usuário e exibi-la para confirmação.
Para testar o funcionamento do leitor biométrico, verificando se ele está capturando imagens corretamente.
Obter digital Anviz não cadastrada por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
2. Obter Digital Não Cadastrada (por ID)
Descrição:
Captura a imagem de uma digital recém-colocada no leitor, utilizando o ID do controlador registrado no sistema.
GET /api/v1/accessControllers/{id}/fingerprints
Quando Usar:
Para iniciar um processo de cadastro biométrico a partir de um sistema central, sem depender de uma sessão de instância.
Para permitir que um painel de administração capture a imagem de uma digital de um dispositivo remoto.
Obter digital Anviz não cadastrada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
3. Remover Todas as Digitais (por Instância)
Descrição:
Apaga permanentemente todos os templates biométricos (digitais) armazenados na memória do controlador. A operação é irreversível. Utiliza o ID da instância de conexão ativa.
DELETE /api/v1/accessControllers/instances/{id}/fingerprints
Quando Usar:
Para limpar completamente um dispositivo antes de implantá-lo em um novo local ou para reinicializar a base de dados biométrica.
Em cenários de segurança onde é necessário remover todos os dados biométricos de um equipamento comprometido.
Remover todas digitais Anviz existentes por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
4. Remover Todas as Digitais (por ID)
Descrição:
Dispara um comando para apagar todos os templates biométricos de um controlador, utilizando seu ID de registro.
DELETE /api/v1/accessControllers/{id}/fingerprints
Quando Usar:
Para executar uma limpeza remota em um dispositivo a partir de um painel de administração central.
Para incluir a remoção de biometrias em rotinas de manutenção automatizadas que rodam em múltiplos dispositivos.
Remover todas as digitais Anviz existentes
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
5. Obter Quantidade de Templates Biométricos (por Instância)
Descrição:
Consulta e retorna a quantidade de templates biométricos que estão atualmente armazenados na memória do controlador. Utiliza o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/fingerprints/sizes
Quando Usar:
Para monitorar o uso da memória do dispositivo e saber quantos espaços para biometria ainda estão disponíveis.
Para exibir estatísticas de ocupação em um painel de gerenciamento do controlador.
Obter quantidade de Templates Biométricos por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
6. Obter Quantidade de Templates Biométricos (por ID)
Descrição:
Retorna a quantidade de templates biométricos armazenados em um controlador, utilizando seu ID de registro.
GET /api/v1/accessControllers/{id}/fingerprints/sizes
Quando Usar:
Para gerar relatórios sobre a capacidade de armazenamento biométrico de todos os dispositivos gerenciados.
Para verificar o espaço utilizado em um dispositivo específico sem a necessidade de uma conexão direta.
Obter quantidade de Templates Biométricos
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
7. Obter Próximo ID de Digital Vago (por Instância)
Descrição:
Consulta o controlador e retorna o próximo número de ID (identificador) que está livre para armazenar um novo template biométrico. Utiliza o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/fingerprints/identities
Quando Usar:
Antes de cadastrar uma nova digital, para obter um ID único e válido para associar ao novo template.
Para automatizar o processo de cadastro, garantindo que não haverá conflito de IDs.
Obter id digital vago por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
8. Obter Próximo ID de Digital Vago (por ID)
Descrição:
Consulta e retorna o próximo ID de biometria disponível em um controlador, utilizando seu ID de registro.
GET /api/v1/accessControllers/{id}/fingerprints/identities
Quando Usar:
Para que um sistema central possa reservar um ID de biometria antes de iniciar um processo de cadastro remoto.
Para validar a disponibilidade de espaço em um dispositivo antes de enviar um comando de cadastro.
Obter id digital vago
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
9. Obter Templates Biométricos (por Instância)
Descrição:
Retorna uma lista de todos os templates biométricos (a representação matemática das digitais) salvos no controlador, utilizando o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/fingerprints/templates
Quando Usar:
Para realizar um backup de todos os templates biométricos de um dispositivo conectado.
Para migrar ou sincronizar os cadastros biométricos de um controlador para outro ou para um banco de dados central.
Obter templates biométricos por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
10. Obter Templates Biométricos (por ID)
Descrição:
Retorna uma lista de todos os templates biométricos (a representação matemática das digitais) salvos no controlador, utilizando o ID do dispositivo registrado no sistema.
GET /api/v1/accessControllers/{id}/fingerprints/templates
Quando Usar:
Para realizar backups agendados ou centralizados de dados biométricos de todos os equipamentos.
Para análises e auditorias de dados biométricos realizadas por um sistema de backend, independentemente do status de conexão do dispositivo.
Obter templates biométricos
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
11. Obter Digital Cadastrada por ID (por Instância)
Descrição:
Consulta e retorna o template biométrico associado a um ID de biometria (idBio) específico que já está cadastrado no controlador. Utiliza o ID da instância de conexão ativa.
GET /api/v1/accessControllers/instances/{id}/fingerprints/{idBio}
Quando usar:
Para verificar ou auditar o template de um usuário específico.
Para exportar a biometria de uma única pessoa a partir do dispositivo.
Obter digital Anviz cadastrada por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Id da biometria
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
12. Obter Digital Cadastrada por ID (por ID)
Descrição:
Consulta e retorna o template biométrico associado a um idBio específico, utilizando o ID do controlador no sistema.
GET /api/v1/accessControllers/{id}/fingerprints/{idBio}
Quando Usar:
Para que um sistema central possa verificar o template de um usuário em qualquer dispositivo da rede.
Para confirmar se a biometria de um usuário foi sincronizada corretamente com um dispositivo remoto.
Obter digital Anviz cadastrada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Id da biometria
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
13. Vincular/Apagar Digital (338 bytes, um dedo) (por Instância)
Descrição:
Envia um comando para vincular um novo template biométrico (de 338 bytes, representando um dedo) a um ID de usuário ou para apagar um template existente. Utiliza o ID da instância de conexão ativa.
POST /api/v1/accessControllers/instances/{id}/fingerprints/fingers/one
Quando Usar:
No passo final do cadastro, para salvar o template biométrico capturado na memória do controlador e associá-lo a um usuário.
Para remover a biometria de um usuário específico do dispositivo, liberando o ID.
Vincular/Apagar Digital ANVIZ (Biometria) 338 bytes, uma digital, por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
14. Vincular/Apagar Digital (338 bytes, um dedo) (por ID)
Descrição:
Envia um comando para vincular ou apagar um template biométrico de 338 bytes, utilizando o ID do controlador no sistema.
POST /api/v1/accessControllers/{id}/fingerprints/fingers/one
Quando Usar:
Para cadastrar ou remover a biometria de um usuário em um dispositivo específico a partir de um painel de administração central.
Para sincronizar um novo cadastro de usuário (incluindo biometria) com múltiplos dispositivos de forma assíncrona.
Vincular/Apagar Digital ANVIZ (Biometria) 338 bytes, uma digital
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
15. Vincular/Apagar Digital (676 bytes, dois dedos) (por Instância)
Descrição:
Envia um comando para vincular um novo template biométrico (de 676 bytes, representando dois dedos para maior precisão) a um ID de usuário ou para apagar um template existente. Utiliza o ID da instância de conexão ativa.
POST /api/v1/accessControllers/instances/{id}/fingerprints/fingers/two
Quando Usar:
Para cadastros que exigem maior segurança e precisão, utilizando o template combinado de duas leituras (dois dedos).
Para remover um cadastro biométrico duplo de um usuário específico.
Vincular/Apagar Digital ANVIZ (Biometria) 676 bytes, uma digital, por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância da conexão
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
16. Vincular/Apagar Digital (676 bytes, dois dedos) (por ID)
Descrição:
Envia um comando para vincular ou apagar um template biométrico de 676 bytes (dois dedos), utilizando o ID do controlador no sistema.
POST /api/v1/accessControllers/{id}/fingerprints/fingers/two
Quando Usar:
Para aplicar um cadastro de alta precisão a um dispositivo remotamente.
Para gerenciar o ciclo de vida de cadastros biométricos duplos a partir de um sistema centralizado.
Vincular/Apagar Digital ANVIZ (Biometria) 676 bytes, duas digitais
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do controlador de acesso
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USOK
Bad Request
Atualizado