MCI/API

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(Criou página com ''''API de integração com catraca IP uTech [http://utech.com.br/site/catraca/ MCI]''' __TOC__ == Protocolo / Formato das requisições == <BR/> === Integração da catraca ...')
 
(→‎Comandos)
Linha 77: Linha 77:
 
! scope="row" colspan=2 style="width: 25%" align="center"| Comandos enviados pela Aplicação à  
 
! scope="row" colspan=2 style="width: 25%" align="center"| Comandos enviados pela Aplicação à  
 
|-
 
|-
−
! scope="row" style="width: 40%" align="right"| [[MPI/API/CmdStatus|'''Status''']]
+
! scope="row" style="width: 40%" align="right"| [[MCI/API/CmdVersion|'''Versão''']]
−
| Comando enviado para o porteiro solicitando status dos relés, sensores e botoeiras.
+
| Comando enviado para a catraca, solicitando modelo, serial e versão do firmware.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdGerarChamada|'''Gerar chamada''']]
+
! scope="row" style="width: 40%" align="right"| [[MCI/API/CmdStatus|'''Status''']]
−
| Comando enviado para o porteiro para gerar uma chamadas.
+
| Comando enviado para a catraca solicitando status dos relés, sensores e botoeiras.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdLiberarChamada|'''Liberar chamada''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdGerarChamada|'''Gerar chamada''']]
 +
| Comando enviado para a catraca para gerar uma chamadas.
 +
|-
 +
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdLiberarChamada|'''Liberar chamada''']]
 
| Comando enviado para liberar/desligar uma chamada.
 
| Comando enviado para liberar/desligar uma chamada.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdCallStatus|'''Status da chamada''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdCallStatus|'''Status da chamada''']]
 
| Comando enviado para verificar o status de uma chamada em andamento.
 
| Comando enviado para verificar o status de uma chamada em andamento.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdListarUsuarios|'''Listar usuários''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdListarUsuarios|'''Listar usuários''']]
−
| Comando enviado para o porteiro para solicitar a lista de usuários cadastrados.
+
| Comando enviado para a catraca para solicitar a lista de usuários cadastrados.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdGetUser|'''Buscar Usuário''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdGetUser|'''Buscar Usuário''']]
−
| Comando enviado para o porteiro para solicitar a configuração de um usuário.
+
| Comando enviado para a catraca para solicitar a configuração de um usuário.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdAdicionarUsuario|'''Adicionar usuário''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdAdicionarUsuario|'''Adicionar usuário''']]
−
| Comando enviado para o porteiro solicitando a inclusão de um novo usuário.
+
| Comando enviado para a catraca solicitando a inclusão de um novo usuário.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdAdicionarUsuarioAuto|'''Adicionar usuário automaticamente''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdAdicionarUsuarioAuto|'''Adicionar usuário automaticamente''']]
−
| Comando enviado para o porteiro solicitando a inclusão automática de um novo usuário. (Será inserido automaticamente o próximo cartão ou QR Code lido.
+
| Comando enviado para a catraca solicitando a inclusão automática de um novo usuário. (Será inserido automaticamente o próximo cartão ou QR Code lido.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdAdicionarFingerprint|'''Cadastrar Biometria''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdAdicionarFingerprint|'''Cadastrar Biometria''']]
−
| Comando enviado para o porteiro para cadastrar a Biometria de um usuário.
+
| Comando enviado para a catraca para cadastrar a Biometria de um usuário.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdCheckUser|'''Verificar Permissões de um usuário''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdCheckUser|'''Verificar Permissões de um usuário''']]
−
| Comando enviado para o porteiro para verificar se um usuário tem permissão de acesso.
+
| Comando enviado para a catraca para verificar se um usuário tem permissão de acesso.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdRemoverUsuario|'''Remover usuário''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdRemoverUsuario|'''Remover usuário''']]
−
| Comando enviado para o porteiro solicitando remoção de um usuário.
+
| Comando enviado para a catraca solicitando remoção de um usuário.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdRemoverUsuarioAutomaticamente|'''Remover usuário automaticamente''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdRemoverUsuarioAutomaticamente|'''Remover usuário automaticamente''']]
−
| Comando enviado para o porteiro solicitando remoção automática de um usuário. Será removido o próximo cartão, QR Code, RF 433 ou Fingerprint lido pelo porteiro.
+
| Comando enviado para a catraca solicitando remoção automática de um usuário. Será removido o próximo cartão, QR Code, RF 433 ou Fingerprint lido pela catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdRemoverTodosUsuarios|'''Remover todos os usuários''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdRemoverTodosUsuarios|'''Remover todos os usuários''']]
−
| Comando enviado para o porteiro solicitando a remoção de '''TODOS''' os usuários.
+
| Comando enviado para a catraca solicitando a remoção de '''TODOS''' os usuários.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdListaLogsDeAcesso|'''Listar log's de acesso''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdListaLogsDeAcesso|'''Listar log's de acesso''']]
−
| Comando enviado para o porteiro solicitando os log's de acessos.
+
| Comando enviado para a catraca solicitando os log's de acessos.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdRemoveLogsDeAcesso|'''Remover log's de acesso''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdRemoveLogsDeAcesso|'''Remover log's de acesso''']]
−
| Comando enviado para o porteiro solicitando a remoção de toda a lista de log's de acessos.
+
| Comando enviado para a catraca solicitando a remoção de toda a lista de log's de acessos.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdControlarRele|'''Controlar acionamento dos relês''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdControlarRele|'''Controlar acionamento dos relês''']]
−
| Comando enviado para o porteiro para controlar o acionamento/status dos Relês.
+
| Comando enviado para a catraca para controlar o acionamento/status dos Relês.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdControlarAlarme|'''Controlar acionamento do alarme''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdControlarAlarme|'''Controlar acionamento do alarme''']]
−
| Comando enviado para o porteiro para controlar o acionamento/status dos alarmes.
+
| Comando enviado para a catraca para controlar o acionamento/status dos alarmes.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdFuncaoPanico|'''Controlar função pânico''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdFuncaoPanico|'''Controlar função pânico''']]
−
| Comando enviado para o porteiro para controlar o acionamento/status da função pânico.
+
| Comando enviado para a catraca para controlar o acionamento/status da função pânico.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdListaAlarmes|'''Listar Status dos Alarmes''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdListaAlarmes|'''Listar Status dos Alarmes''']]
−
| Comando enviado para buscar o estado atual dos alarmes do porteiro.
+
| Comando enviado para buscar o estado atual dos alarmes da catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdListaLeitores|'''Listar Leitores Remotos''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdListaLeitores|'''Listar Leitores Remotos''']]
−
| Comando enviado para buscar o estado atual dos alarmes do porteiro.
+
| Comando enviado para buscar o estado atual dos alarmes da catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdGetVideo|'''Solicitar configurações de Vídeo''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdGetVideo|'''Solicitar configurações de Vídeo''']]
−
| Comando enviado para solicitar a URL de video da câmera ref. ao porteiro.
+
| Comando enviado para solicitar a URL de video da câmera ref. aa catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdLocalizacao|'''Buscar Localização''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdLocalizacao|'''Buscar Localização''']]
−
| Comando enviado para buscar a localização do porteiro (configurado via interface WEB).
+
| Comando enviado para buscar a localização da catraca (configurado via interface WEB).
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdGetConfig|'''Buscar Configuração''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdGetConfig|'''Buscar Configuração''']]
−
| Comando enviado para pegar a configuração do porteiro.
+
| Comando enviado para pegar a configuração da catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdSetConfig|'''Configurar Porteiro''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdSetConfig|'''Configurar Porteiro''']]
−
| Comando enviado para configurar o porteiro.
+
| Comando enviado para configurar a catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdRestoreConfig|'''Restaurar Configuração do Porteiro''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdRestoreConfig|'''Restaurar Configuração do Porteiro''']]
−
| Comando enviado para restaurar a configuração do porteiro para a configuração de padrão/fabrica.
+
| Comando enviado para restaurar a configuração da catraca para a configuração de padrão/fabrica.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdReiniciarEquipamento|'''Reiniciar o equipamento''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdReiniciarEquipamento|'''Reiniciar o equipamento''']]
−
| Comando enviado para reiniciar o porteiro.
+
| Comando enviado para reiniciar a catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/CmdUpdate|'''Atualizar o firmware do equipamento''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/CmdUpdate|'''Atualizar o firmware do equipamento''']]
−
| Comando enviado para realizar o update de firmware do porteiro.
+
| Comando enviado para realizar o update de firmware da catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/ReaderGetConfig|'''Buscar configuração de leitor externo (ULIP)''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/ReaderGetConfig|'''Buscar configuração de leitor externo (ULIP)''']]
−
| Comando enviado para ler a configuração de um '''Leitor''' externo - (ULIP) o update de firmware do porteiro.
+
| Comando enviado para ler a configuração de um '''Leitor''' externo - (ULIP) o update de firmware da catraca.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/ReaderSetConfig|'''Configurar leitor externo (ULIP)''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/ReaderSetConfig|'''Configurar leitor externo (ULIP)''']]
 
| Comando enviado configurar um '''Leitor''' externo - (ULIP).
 
| Comando enviado configurar um '''Leitor''' externo - (ULIP).
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/GetDateTime|'''Buscar Data/Hora atual do equipamento''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/GetDateTime|'''Buscar Data/Hora atual do equipamento''']]
−
| Comando enviado para solicitar DATA e HORA atual do porteiro MPI.
+
| Comando enviado para solicitar DATA e HORA atual da catraca MCI.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/SetDateTime|'''Configurar Data/Hora do equipamento''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/SetDateTime|'''Configurar Data/Hora do equipamento''']]
−
| Comando enviado configurar a DATA e HORA atual do porteiro MPI.
+
| Comando enviado configurar a DATA e HORA atual da catraca MCI.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/GetAccessLog|'''Buscar Lista de acesso''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/GetAccessLog|'''Buscar Lista de acesso''']]
−
| Comando utilizado para buscar a lista de acesso realizados no porteiro MPI.
+
| Comando utilizado para buscar a lista de acesso realizados na catraca MCI.
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/DelAccessLog|'''Remover lista de acesso''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/DelAccessLog|'''Remover lista de acesso''']]
−
| Comando utilizado para remover a lista de acesso realizados no porteiro MPI
+
| Comando utilizado para remover a lista de acesso realizados na catraca MCI
 
|-
 
|-
−
! scope="row" style="width: 30%" align="right"| [[MPI/API/PlayMessage|'''Reproduzir mensagem''']]
+
! scope="row" style="width: 30%" align="right"| [[MCI/API/PlayMessage|'''Reproduzir mensagem''']]
−
| Comando utilizado para reproduzir mensagens pré-definidas no porteiro MPI.
+
| Comando utilizado para reproduzir mensagens pré-definidas na catraca MCI.
 
|}
 
|}
  

Edição de 20h00min de 24 de julho de 2019

API de integração com catraca IP uTech MCI

Tabela de conteúdo


Protocolo / Formato das requisições


Integração da catraca uTech MCI via API - Comandos e Eventos

  • Comandos: Serão enviados da aplicação para a catraca.
  • Eventos: Serão enviados pela catraca para a aplicação (O destino dos eventos deve ser configurado via interface web da catraca).



Métodos e Formatos

Formato dos Comandos

  • Comandos enviados para a catraca, 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_DA_CATRACA:porta/?request=<requisição>...

Resposta do Comando

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

{
  "relay":"off",
  "sensor":"on",
  "button":"off"
}


Formato dos Eventos

  • Para eventos gerados pela catraca, 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.1


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


Resposta do evento

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

Autenticação


Para acesso com usuário e senha, é usulizado o método e autenticação Basic'. Veja sobe em: Basic Authentication

Comandos

Comandos enviados pela Aplicação à
Versão Comando enviado para a catraca, solicitando modelo, serial e versão do firmware.
Status Comando enviado para a catraca solicitando status dos relés, sensores e botoeiras.
Gerar chamada Comando enviado para a catraca para gerar uma chamadas.
Liberar chamada Comando enviado para liberar/desligar uma chamada.
Status da chamada Comando enviado para verificar o status de uma chamada em andamento.
Listar usuários Comando enviado para a catraca para solicitar a lista de usuários cadastrados.
Buscar Usuário Comando enviado para a catraca para solicitar a configuração de um usuário.
Adicionar usuário Comando enviado para a catraca solicitando a inclusão de um novo usuário.
Adicionar usuário automaticamente Comando enviado para a catraca 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 a catraca para cadastrar a Biometria de um usuário.
Verificar Permissões de um usuário Comando enviado para a catraca para verificar se um usuário tem permissão de acesso.
Remover usuário Comando enviado para a catraca solicitando remoção de um usuário.
Remover usuário automaticamente Comando enviado para a catraca solicitando remoção automática de um usuário. Será removido o próximo cartão, QR Code, RF 433 ou Fingerprint lido pela catraca.
Remover todos os usuários Comando enviado para a catraca solicitando a remoção de TODOS os usuários.
Listar log's de acesso Comando enviado para a catraca solicitando os log's de acessos.
Remover log's de acesso Comando enviado para a catraca solicitando a remoção de toda a lista de log's de acessos.
Controlar acionamento dos relês Comando enviado para a catraca para controlar o acionamento/status dos Relês.
Controlar acionamento do alarme Comando enviado para a catraca para controlar o acionamento/status dos alarmes.
Controlar função pânico Comando enviado para a catraca para controlar o acionamento/status da função pânico.
Listar Status dos Alarmes Comando enviado para buscar o estado atual dos alarmes da catraca.
Listar Leitores Remotos Comando enviado para buscar o estado atual dos alarmes da catraca.
Solicitar configurações de Vídeo Comando enviado para solicitar a URL de video da câmera ref. aa catraca.
Buscar Localização Comando enviado para buscar a localização da catraca (configurado via interface WEB).
Buscar Configuração Comando enviado para pegar a configuração da catraca.
Configurar Porteiro Comando enviado para configurar a catraca.
Restaurar Configuração do Porteiro Comando enviado para restaurar a configuração da catraca para a configuração de padrão/fabrica.
Reiniciar o equipamento Comando enviado para reiniciar a catraca.
Atualizar o firmware do equipamento Comando enviado para realizar o update de firmware da catraca.
Buscar configuração de leitor externo (ULIP) Comando enviado para ler a configuração de um Leitor externo - (ULIP) o update de firmware da catraca.
Configurar leitor externo (ULIP) Comando enviado configurar um Leitor externo - (ULIP).
Buscar Data/Hora atual do equipamento Comando enviado para solicitar DATA e HORA atual da catraca MCI.
Configurar Data/Hora do equipamento Comando enviado configurar a DATA e HORA atual da catraca MCI.
Buscar Lista de acesso Comando utilizado para buscar a lista de acesso realizados na catraca MCI.
Remover lista de acesso Comando utilizado para remover a lista de acesso realizados na catraca MCI
Reproduzir mensagem Comando utilizado para reproduzir mensagens pré-definidas na catraca MCI.

Eventos

Eventos enviados pelo porteiro para a Aplicação
Evento de relê Evento enviado pelo porteiro informando status estado de relê.
Evento de Sensor Evento enviado pelo porteiro informando status estado de sensor.
Evento de botoeira Evento enviado pelo porteiro informando status estado de botoeira.
Evento de Arrombamento Evento enviado pelo porteiro informando que foi detecção de arrombamento de porta.
Evento Mifire / NFC Evento enviado pelo porteiro informando status de cartão lido.
Evento RF433 Code Evento enviado pelo porteiro informando status de cartão/controle RF 433 lido.
Evento Fingerprint Evento enviado pelo porteiro informando status de biometria lida.
Evento Fingerprint Status (Enrolment) Evento enviado pelo porteiro informando o status de cadastro de uma biometria (Enrolment).
Evento de Usuário e Senha Evento enviado pelo porteiro informando nova requisição de acesso por usuário e senha.
Evento QR Code Evento enviado pelo porteiro informando status de leitura de QR Code.
Evento Add User Evento enviado pelo porteiro informando que um novo usuário foi adicionado.
Evento Del User Evento enviado pelo porteiro informando que um usuário foi removido.
Evento de Cadastro Automático de Usuário Evento enviado pelo porteiro 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 porteiro informando o status da remoção automática de usuário (enviado após o comando eraseuser.
Evento de Alarme Evento enviado pelo porteiro informando novo status de alarme.
Evento Pânico Evento enviado pelo porteiro informando status da função pânico.
Evento de Chamada Evento enviado pelo porteiro informando um novo status de chamada.
Evento de Violação (Tamper) Evento enviado pelo porteiro informando que o porteiro foi violado (Evento de Tamper).
Evento de Boot Evento enviado pelo porteiro informando Boot do porteiro.



QR Code Dinâmico

O MPI possui uma função para controle de QR Code's dinâmicos (Com validade de tempo) Para utilização, siga os passos abaixo:

  1. Verifique a versão de software do seu porteiro. Ela DEVE ser igual ou superior a versão 1.1.17.
  2. Habilite no porteiro a função de QR Code dinâmico. Acesse o menu Controle de Acesso, aba Geral e habilite os campos: 
* Habilitar QRCODE Dinâmico
* Validade de QRCODE Dinâmico
  1. Agora, o porteiro está pronto para utilização. Veja no link QR Code Dinâmico como é o seu funcionamento.


Voltar

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

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