MLI/API

De uTech Tecnologia
Ir para: navegação, pesquisa

API de integração com Leitor uTech MLI

Tabela de conteúdo


Protocolo / Formato das requisições


Integração do leitor uTech MLI via API - Comandos e Eventos

  • Comandos: Serão enviados da aplicação para o leitor.
  • Eventos: Serão enviados pelo leitor para a aplicação (O destino dos eventos deve ser configurado no Leitor).



Métodos e Formatos

Formato dos Comandos

  • Comandos enviados para o leitor, devem utilizar o protocolo HTTP] e os métodos [GET] e [POST].
  • As respostas estarão codificadas no padrão JSON (Caso houver dados. Veja a lista completa de comandos e eventos abaixo)

Requisição: 

http://IP_DO_LEITOR:porta/?request=<requisição>...

Resposta do Comando

    • 400 => Requisição ou parâmetros incorretos!
    • 200 => Requisição OK. 
Content-Type: application/json

{
    "Interface1":{
        "relay":"off",
        "sensor":"off",
        "button":"off"
    },
    "Interface2":{
        "relay":"off",
        "sensor":"off",
        "button":"off"
    }
}


Formato dos Eventos

  • Para eventos gerados pelo leitor, será enviado uma requisição [HTTP] utilizando o método [GET].

Evento: 

http://ip:porta/url/?event=alarm&state=on
User-Agent: uTech/0000002874
Connection: close
Date: Wed, 13 Jun 2018 17:22:35
Host: 10.0.0.200


Utilize o campo (header http) User-Agent para identificar qual leitor está enviando os eventos para sua aplicação.


Resposta do evento

A aplicação deverá responder os eventos com o Status code 200 OK


  • Os comandos enviados para o MLI DEVEM ser síncronos. DEVE-SE executar e esperar sua resposta antes de enviar qualquer outro comando para o leitor.
  • No caso de configuração biométrica, este comando irá demorar pelo menos 500ms.


Acesso e Autenticação


  • O Acesso padrão a API é o mesmo da interface WEB de configuração.
  • Para acesso com usuário e senha, é utilizado o método e autenticação Basic'. Veja sobe em: Basic Authentication



Comandos

Comandos enviados pela Aplicação ao leitor
Status Comando enviado para o leitor solicitando status dos relés, sensores e botoeiras.
Status e Níveis dos Sensores de Telemetria Comando enviado para o leitor solicitando status de telemetria dos sensores.
Log de Dados da Telemetria Comando enviado para o leitor solicitando o log dos últimos 8000 status dos sensores de telemetria.
Remover Log de Telemetria Comando enviado para o leitor solicitando para apagar todos os registros/logs de telemetria.
Listar usuários Comando enviado para o leitor para solicitar a lista de usuários cadastrados.
Buscar Usuário Comando enviado para o leitor para solicitar a configuração de um usuário.
Adicionar usuário Comando enviado para o leitor solicitando a inclusão de um novo usuário.
Adicionar usuário automaticamente Comando enviado para o leitor solicitando a inclusão automática de um novo usuário. (Será inserido automaticamente o próximo cartão ou QR Code lido.
Cadastrar Biometria Comando enviado para o leitor para cadastrar a Biometria de um usuário.
Verificar Permissões de um usuário Comando enviado para o leitor para verificar se um usuário tem permissão de acesso.
Remover usuário Comando enviado para o leitor solicitando remoção de um usuário.
Remover usuário automaticamente Comando enviado para o leitor solicitando remoção automática de um usuário. Será removido o próximo cartão, QR Code, RF 433 ou Fingerprint lido pelo leitor.
Remover todos os usuários Comando enviado para o leitor solicitando a remoção de TODOS os usuários.
Listar log's de acesso Comando enviado para o leitor solicitando os log's de acessos.
Remover log's de acesso Comando enviado para o leitor solicitando a remoção de toda a lista de log's de acessos.
Controlar acionamento dos relês Comando enviado para o leitor para controlar o acionamento/status dos Relês.
Controlar acionamento do alarme Comando enviado para o leitor para controlar o acionamento/status dos alarmes.
Controlar função pânico Comando enviado para o leitor para controlar o acionamento/status da função pânico.
Listar Status dos Alarmes Comando enviado para buscar o estado atual dos alarmes do leitor.
Buscar Localização Comando enviado para buscar a localização do leitor (configurado via interface WEB).
Buscar Configuração Comando enviado para pegar a configuração do leitor.
Configurar Leitor Comando enviado para configurar o leitor.
Restaurar Configuração do Leitor Comando enviado para restaurar a configuração do leitor para a configuração de padrão/fabrica.
Reiniciar o equipamento Comando enviado para reiniciar o leitor.
Atualizar o firmware do equipamento Comando enviado para realizar o update de firmware do leitor.
Buscar Data/Hora atual do equipamento Comando enviado para solicitar DATA e HORA atual do leitor MLI.
Configurar Data/Hora do equipamento Comando enviado configurar a DATA e HORA atual do leitor MLI.
Buscar Lista de acesso Comando utilizado para buscar a lista de acesso realizados no leitor.
Remover lista de acesso Comando utilizado para remover a lista de acesso realizados no leitor
Emitir Beep Comando utilizado para emitir um beep curto ou longo.

Eventos

Eventos enviados pelo leitor para a Aplicação
Evento de relê Evento enviado pelo leitor informando status de relê.
Evento de Sensor Evento enviado pelo leitor informando status de sensor.
Evento de Temperatura e Umidade Evento enviado pelo leitor informando status/alteração nos níveis de temperatura e umidade.
Evento de Detecção de Gás Evento enviado pelo leitor informando status/alteração nos níveis de detecção de gás.
Evento de sensor de Nível Evento enviado pelo leitor informando status do sensor de nível.
Evento de sensor de Volume Evento enviado pelo leitor informando status do sensor de volume.
Evento de Detecção de Movimento Evento enviado pelo leitor informando status de detecção de movimento.
Evento de Arrombamento Evento enviado pelo leitor informando que foi detecção de arrombamento de porta.
Evento Mifire / NFC Evento enviado pelo leitor informando status de cartão lido.
Evento RF433 Code Evento enviado pelo leitor informando status de cartão/controle RF 433 lido.
Evento Fingerprint Evento enviado pelo leitor informando status de biometria lida.
Evento Fingerprint Status (Enrolment) Evento enviado pelo leitor informando o status de cadastro de uma biometria (Enrolment).
Evento de Usuário e Senha Evento enviado pelo leitor informando nova requisição de acesso por usuário e senha.
Evento QR Code Evento enviado pelo leitor informando status de leitura de QR Code.
Evento Add User Evento enviado pelo leitor informando que um novo usuário foi adicionado.
Evento Del User Evento enviado pelo leitor informando que um usuário foi removido.
Evento de Cadastro Automático de Usuário Evento enviado pelo leitor informando o status do cadastro automático de usuário (enviado após o comando probeuser.
Evento de Remoção Automática de Usuário Evento enviado pelo leitor informando o status da remoção automática de usuário (enviado após o comando eraseuser.
Evento de Alarme Evento enviado pelo leitor informando novo status de alarme.
Evento Pânico Evento enviado pelo leitor informando status da função pânico.
Evento de Boot Evento enviado pelo leitor informando Boot do leitor.
Evento Sensor de Loop Evento enviado pelo leitor informando status do sensor de corrente de loop.



Voltar

Obtida de "https://wiki.utech.com.br/wiki/index.php?title=MLI/API&oldid=10189"
Ferramentas pessoais
Espaços nominais

Variantes
Visualizações
Ações
Navegação
Ferramentas