calendar-exclamationCaptura de Leituras

Esta seção gerencia o processo de captura em tempo real de leituras e acionamentos provenientes de diversos dispositivos, como controladores de acesso MG3000 e antenas veiculares. Os endpoints permitem iniciar e interromper a coleta desses dados, sendo essenciais para o monitoramento contínuo e a integração de eventos de hardware com o sistema.

Guarita:

1. Iniciar Captura de Leituras de Acionamentos

Descrição:

Inicia o processo de captura de leituras de acionamentos provenientes do dispositivo MG3000. Uma vez ativado, o sistema começará a receber e processar os dados de acionamento em tempo real.

  • POST /api/v1/gatewayEvents/accessControllers/reads

Quando Usar:

  • Para habilitar o monitoramento de acionamentos de um dispositivo MG3000.

  • Ao iniciar um período de coleta de dados de acesso, como no início de um turno ou evento.

Iniciar a captura de leituras de acionamentos no MG3000

post

Iniciar a captura de leituras de acionamentos no MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta
instanceinteger · int32Obrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
post
/api/v1/gatewayEvents/accessControllers/reads

2. Interromper Captura de Leituras de Acionamentos

Descrição:

Interrompe o processo de captura de leituras de acionamentos do dispositivo MG3000. Após a execução deste endpoint, o sistema deixará de receber novos dados de acionamento.

  • DELETE /api/v1/gatewayEvents/accessControllers/reads

Quando Usar:

  • Para desabilitar o monitoramento de acionamentos quando não for mais necessário.

  • Ao finalizar um período de coleta de dados, como ao final de um turno de trabalho.

Interromper a captura de leituras de acionamentos no MG3000

delete

Interromper a captura de leituras de acionamentos no MG3000

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta
instanceinteger · int32Obrigatório
cultureNamestringOpcionalDefault: en-US
Respostas
chevron-right
200

OK

application/json
delete
/api/v1/gatewayEvents/accessControllers/reads

Antena:

3. Iniciar Captura de Leituras de Tag Antena Veicular

Descrição:

Inicia o processo de captura em tempo real de leituras de tags de antenas veiculares, enviando esses eventos para o sistema.

  • POST /api/v1/gatewayEvents/vehicleAntennas/reads

Quando Usar:

  • Para ativar o monitoramento contínuo de veículos que passam por antenas de leitura de tags.

  • Para integrar os eventos de passagem de veículos com um sistema de controle de acesso ou estacionamento.

Iniciar a captura de leituras de tag antena veicular

post

Iniciar a captura de leituras de tag antena veicular

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta
instanceinteger · int32Obrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
post
/api/v1/gatewayEvents/vehicleAntennas/reads

4. Interromper Captura de Leituras de Tag Antena Veicular

Descrição:

Interrompe o processo de captura em tempo real de leituras de tags de antenas veiculares, cessando o envio desses eventos para o sistema.

  • DELETE /api/v1/gatewayEvents/vehicleAntennas/reads

Quando Usar:

  • Para desativar o monitoramento de antenas veiculares quando não for mais necessário.

  • Para otimizar o uso de recursos do sistema, interrompendo a coleta de dados de antenas inativas.

Interromper a captura de leituras de tag antena veicular

delete

Interromper a captura de leituras de tag antena veicular

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta
instanceinteger · int32Obrigatório
cultureNamestringOpcionalDefault: en-US
Respostas
chevron-right
200

OK

application/json
delete
/api/v1/gatewayEvents/vehicleAntennas/reads

Facial:

5. Iniciar Captura de Leituras de Biometria Facial

Descrição

Inicia o processo de captura e transmissão de leituras de reconhecimento facial provenientes dos dispositivos configurados, habilitando o recebimento contínuo de eventos faciais no gateway.

  • POST /api/v1/gatewayEvents/facialRecognitions/reads

Quando Usar

  • Para habilitar o monitoramento de leituras biometrias faciais de um dispositivo.

  • Ao iniciar um período de coleta de dados biométricos, como no começo de um turno, operação ou sessão de auditoria.

Iniciar a captura de leituras de biometria facial

post

Iniciar a captura de leituras de biometria facial

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta
instanceinteger · int32Obrigatório
cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US
Respostas
chevron-right
200

OK

application/json
post
/api/v1/gatewayEvents/facialRecognitions/reads

6. Interromper Captura de Leituras de Biometria Facial

Descrição

Encerra o processo de captura ativa de leituras de reconhecimento facial iniciado previamente, interrompendo o envio de eventos faciais para o gateway.

  • DELETE /api/v1/gatewayEvents/facialRecognitions/reads

Quando Usar

  • Para parar a recepção contínua de eventos faciais após finalizar um teste, rotina de auditoria ou sessão de monitoramento.

  • Para liberar recursos do sistema ou evitar processamento desnecessário quando a captura em tempo real não for mais necessária.

  • Ao alterar dispositivos, configurações de leitura facial ou reiniciar fluxos dependentes do módulo de reconhecimento facial.

Interromper a captura de leituras de biometria facial

delete

Interromper a captura de leituras de biometria facial

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta
instanceinteger · int32Obrigatório
cultureNamestringOpcionalDefault: en-US
Respostas
chevron-right
200

OK

application/json
delete
/api/v1/gatewayEvents/facialRecognitions/reads

Atualizado