Data e Hora
Esta seção compreende os endpoints dedicados à sincronização e consulta da data e hora dos leitores de biometria facial. Essa funcionalidade é essencial para garantir que os registros de acesso e eventos sejam corretamente carimbados com a hora real.
1. Obter Data e Hora do Leitor (por Instância)
Descrição:
Retorna a data e hora do equipamento com base na instância conectada.
GET /api/v1/facialRecognitions/instances/{id}/timestamps
Quando Usar:
Durante sessões de conexão temporária (via conexão UDP ou por IP);
Em situações onde o equipamento ainda não foi persistido no banco de dados.
Obter data e hora do leitor de biometria facial 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 conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção da data/hora ocorrer com sucesso
Quando ocorrer erro
2. Atualizar Data e Hora do Leitor (por Instância)
Descrição:
Atualiza a data e hora do leitor facial utilizando o identificador da instância conectada.
POST /api/v1/facialRecognitions/instances/{id}/timestamps
Quando Usar:
Durante manutenção técnica ou diagnósticos em conexões temporárias;
Quando ainda não há cadastro definitivo do equipamento no sistema.
Atualizar a data/hora do leitor de biometria facial 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 conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a data/hora for atualizada com sucesso
Quando ocorrer erro
3. Obter Data e Hora do Leitor por ID
Descrição:
Retorna a data e hora atual configurada no leitor de biometria facial, identificado por ID.
GET /api/v1/facialRecognitions/{id}/timestamps
Quando Usar:
Para verificar se o equipamento está com o horário correto;
Durante diagnósticos de eventos registrados com hora incorreta.
Obter data e hora do leitor de biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção da data/hora ocorrer com sucesso
Quando ocorrer erro
4. Atualizar Data e Hora do Leitor (por ID)
Descrição:
Atualiza a data e a hora do equipamento utilizando o ID do leitor facial cadastrado.
POST /api/v1/facialRecognitions/{id}/timestamps
Quando Usar:
Após instalação do equipamento;
Após falhas de energia ou desconfigurações;
Para garantir a sincronização com o servidor do sistema.
Atualizar a data/hora do leitor de biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a data/hora for atualizada com sucesso
Quando ocorrer erro
5. Sincronizar Data/Hora (por Instância)
Descrição:
Envia um comando para sincronizar a data e a hora do leitor de biometria facial com o horário do servidor ou sistema, utilizando o ID de uma instância de conexão ativa.
POST /api/v1/facialRecognitions/instances/{id}/timestamps/syncs
Quando Usar:
Para garantir que o relógio interno do leitor esteja sempre preciso, o que é crucial para o registro correto de eventos.
Para ajustar automaticamente a data/hora do dispositivo, especialmente após quedas de energia ou mudanças de fuso horário.
Sincronizar a data/hora do leitor de biometria facial 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 conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a data/hora for sincronizar com sucesso
Quando ocorrer erro
6. Sincronizar Data/Hora (por ID)
Descrição:
Envia um comando para sincronizar a data e a hora do leitor de biometria facial com o horário do servidor ou sistema, utilizando o ID do dispositivo registrado no sistema.
POST /api/v1/facialRecognitions/{id}/timestamps/syncs
Quando Usar:
Para que um sistema de gerenciamento central possa garantir a sincronização de data/hora de múltiplos leitores, mesmo que não estejam em uma sessão de instância ativa.
Para aplicar uma política de sincronização de tempo em toda a frota de dispositivos de biometria facial.
Sincronizar a data/hora do leitor de biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a data/hora for sincronizar com sucesso
Quando ocorrer erro
7. Obter Modelos de Horário (por Instância)
Descrição:
Retorna uma lista de todos os modelos de horário configurados no leitor de biometria facial, utilizando o ID de uma instância de conexão ativa.
GET /api/v1/facialRecognitions/instances/{id}/timeTemplates
Quando Usar:
Para carregar a lista de modelos de horário existentes em um leitor específico para exibição ou edição.
Para verificar quais modelos de horário estão atualmente em uso no dispositivo.
Obter informações de modelos de horário de biometria facial 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 conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
8. Obter Modelos de Horário (por ID)
Descrição:
Retorna uma lista de todos os modelos de horário configurados no leitor de biometria facial, utilizando o ID do dispositivo registrado no sistema.
GET /api/v1/facialRecognitions/{id}/timeTemplates
Quando Usar:
Para consultar os modelos de horário de um leitor a partir de um sistema central, mesmo que o dispositivo não esteja em uma sessão de instância ativa.
Para realizar auditorias ou backups dos modelos de horário de múltiplos leitores.
Obter informações de modelos de horário de biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
9. Criar Modelo de Horário (por Instância)
Descrição:
Cria um novo modelo de horário no leitor de biometria facial, definindo períodos de acesso ou restrição, utilizando o ID de uma instância de conexão ativa
POST /api/v1/facialRecognitions/instances/{id}/timeTemplates
Quando Usar:
Para configurar novas regras de acesso baseadas em tempo diretamente no leitor.
Para adicionar um modelo de horário personalizado para um grupo de usuários ou uma porta específica.
Criar modelo de horário de biometria facial 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 conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
10. Criar Modelo de Horário (por ID)
Descrição:
Cria um novo modelo de horário no leitor de biometria facial, definindo períodos de acesso ou restrição, utilizando o ID do dispositivo registrado no sistema.
POST /api/v1/facialRecognitions/{id}/timeTemplates
Quando Usar:
Para provisionar novos modelos de horário em leitores remotos a partir de um sistema de gerenciamento central.
Para aplicar um modelo de horário padrão a múltiplos dispositivos de forma automatizada.
Criar modelo de horário de biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
11. Atualizar Modelo de Horário (por Instância)
Descrição:
Atualiza um modelo de horário existente no leitor de biometria facial, modificando seus períodos de acesso ou restrição, utilizando o ID de uma instância de conexão ativa.
PUT /api/v1/facialRecognitions/instances/{id}/timeTemplates
Quando Usar:
Para ajustar os horários de acesso de um modelo existente em tempo real.
Para modificar as regras de acesso de um leitor específico sem precisar recriar o modelo.
Atualizar modelo de horário de biometria facial 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 conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
12. Atualizar Modelo de Horário (por ID)
Descrição:
Atualiza um modelo de horário existente no leitor de biometria facial, modificando seus períodos de acesso ou restrição, utilizando o ID do dispositivo registrado no sistema.
PUT /api/v1/facialRecognitions/{id}/timeTemplates
Quando Usar:
Para atualizar modelos de horário em leitores remotos a partir de um sistema de gerenciamento central.
Para aplicar alterações em políticas de acesso baseadas em tempo em múltiplos dispositivos de forma automatizada.
Atualizar modelo de horário de biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
13. Obter Modelo de Horário por ID (por Instância)
Descrição:
Retorna as informações detalhadas de um modelo de horário específico, identificado pelo seu ID (idTimeTemplate), no leitor de biometria facial, utilizando o ID de uma instância de conexão ativa.
GET /api/v1/facialRecognitions/instances/{id}/timeTemplates/{idTimeTemplate}
Quando Usar:
Para consultar os detalhes de um modelo de horário específico para verificação ou depuração.
Para exibir as configurações de um modelo de horário em uma interface de usuário.
Obter informações de modelo de horário por id da biometria facial 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 conectada
Id do modelo de horário
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
14. Obter Modelo de Horário por ID (por ID)
Descrição:
Retorna as informações detalhadas de um modelo de horário específico, identificado pelo seu ID (idTimeTemplate), no leitor de biometria facial, utilizando o ID do dispositivo registrado no sistema.
GET /api/v1/facialRecognitions/{id}/timeTemplates/{idTimeTemplate}
Quando Usar:
Para consultar os detalhes de um modelo de horário específico de um leitor remoto a partir de um sistema central.
Para auditar as configurações de um modelo de horário em um dispositivo específico.
Obter informações de modelo de horário por id da biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Id do modelo de horário
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
15. Apagar Modelo de Horário por ID (por Instância)
Descrição:
paga um modelo de horário específico, identificado pelo seu ID (idTimeTemplate), do leitor de biometria facial, utilizando o ID de uma instância de conexão ativa.
DELETE /api/v1/facialRecognitions/instances/{id}/timeTemplates/{idTimeTemplate}
Quando Usar:
Para remover um modelo de horário que não é mais necessário ou que foi substituído.
Para limpar configurações de acesso baseadas em tempo de um leitor específico.
Apagar modelo de horário por id da biometria facial 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 conectada
Id do modelo de horário
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a deleção ocorrer com sucesso
Quando ocorrer erro
16. Apagar Modelo de Horário por ID (por ID)
Descrição:
Apaga um modelo de horário específico, identificado pelo seu ID (idTimeTemplate), do leitor de biometria facial, utilizando o ID do dispositivo registrado no sistema.
DELETE /api/v1/facialRecognitions/{id}/timeTemplates/{idTimeTemplate}
Quando Usar:
Para remover modelos de horário de leitores remotos a partir de um sistema de gerenciamento central.
Para automatizar a remoção de modelos de horário obsoletos em múltiplos dispositivos.
Apagar modelo de horário por id da biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Id do modelo de horário
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a deleção ocorrer com sucesso
Quando ocorrer erro
17. Obter Próximo ID de Modelo de Horário Vago (por Instância)
Descrição:
Retorna o próximo ID disponível para a criação de um novo modelo de horário no leitor de biometria facial, utilizando o ID de uma instância de conexão ativa.
GET /api/v1/facialRecognitions/instances/{id}/timeTemplates/identities
Quando Usar:
Antes de criar um novo modelo de horário, para obter um ID único e válido para associar a ele.
Para automatizar o processo de criação de modelos de horário, garantindo que não haverá conflito de IDs.
Obter o próximo id de modelos de horário de biometria facial 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 conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
18. Obter Próximo ID de Modelo de Horário Vago (por ID)
Descrição:
Retorna o próximo ID disponível para a criação de um novo modelo de horário no leitor de biometria facial, utilizando o ID do dispositivo registrado no sistema.
GET /api/v1/facialRecognitions/{id}/timeTemplates/identities
Quando Usar:
Para que um sistema de gerenciamento central possa reservar um ID para um novo modelo de horário antes de enviá-lo para um leitor remoto.
Para verificar a disponibilidade de IDs em um leitor específico antes de um processo de criação em lote.
Obter o próximo id de modelos de horário de biometria facial
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id do leitor de biometria facial
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
Atualizado