MCP/API

API de integração com Central MCP uTech - MCP

Protocolo / Formato das requisições

Integração da central MCP uTech via API - Comandos e Eventos

• Comandos: Serão enviados da aplicação para a central MCP.
• Eventos: Serão enviados pela central MCP para a aplicação (O destino dos eventos deve ser configurado na central MCP).

Métodos e Formatos

Formato dos Comandos

• Comandos enviados para a central MCP 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_MCP: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 pela central MCP, 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 dispositivo uTech/MCP 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 para a central MCP
Version	Comando enviado para a central MCP solicitando versão/modelo da central MCP.
Status	Comando enviado para a central MCP solicitando status dos relés, sensores e botoeiras das interfaces READER1 (RL1 + S1 + BTN1), READER2 (RL2 + S2 + BTN2), READER3 (RL3 + S3 + BTN3) e READER4 (RL4 + S4 + BTN4)
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.
Relay Status	Comando enviado para a central MCP solicitando status dos relés auxiliares RLAUX1, RLAUX2 e RLAUX3.
Sensor Status	Comando enviado para a central MCP solicitando status dos sensores auxiliares SAUX1, SAUX2, SAUX3, SAUX4, SAUX5 e SAUX6.
Alarm Status	Comando enviado para a central MCP solicitando status do relê (RLALM) e sensor de alarme SALM.
Gerar chamada	Comando enviado para a central MCP 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 central MCP para solicitar a lista de usuários cadastrados.
Buscar Usuário	Comando enviado para a central MCP para solicitar a configuração de um usuário.
Adicionar usuário	Comando enviado para a central MCP solicitando a inclusão de um novo usuário.
Adicionar usuário automaticamente	Comando enviado para a central MCP 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 central MCP para cadastrar a Biometria de um usuário.
Verificar Permissões de um usuário	Comando enviado para a central MCP para verificar se um usuário tem permissão de acesso.
Remover usuário	Comando enviado para a central MCP solicitando remoção de um usuário.
Remover usuário automaticamente	Comando enviado para a central MCP solicitando remoção automática de um usuário. Será removido o próximo cartão, QR Code, RF 433 ou Fingerprint lido pela central MCP.
Remover todos os usuários	Comando enviado para a central MCP solicitando a remoção de TODOS os usuários.
Listar log's de acesso	Comando enviado para a central MCP solicitando os log's de acessos.
Remover log's de acesso	Comando enviado para a central MCP solicitando a remoção de toda a lista de log's de acessos.
Controlar acionamento dos relês	Comando enviado para a central MCP para controlar o acionamento/status dos Relês RL1, RL2, RL3 e RL4.
Controlar acionamento dos relês auxiliares	Comando enviado para a central MCP para controlar o acionamento/status dos Relês auxiliares RLAUX1, RLAUX2 ou RLAUX3.
Controlar acionamento do alarme	Comando enviado para a central MCP para controlar o acionamento/status dos alarmes.
Controlar função pânico	Comando enviado para a central MCP para controlar o acionamento/status da função pânico.
Listar Status dos Alarmes	Comando enviado para buscar o estado atual dos alarmes da central MCP.
Listar Leitores Remotos	Comando enviado para buscar buscar a lista Leitores Remotos da central MCP.
Buscar Localização	Comando enviado para buscar a localização da central MCP (configurado via interface WEB).
Buscar Configuração	Comando enviado para pegar a configuração da central MCP.
Configurar Central	Comando enviado para configurar a central MCP.
Restaurar Configuração do Central	Comando enviado para restaurar a configuração da central MCP para a configuração de padrão/fabrica.
Reiniciar o equipamento	Comando enviado para reiniciar a central MCP.
Reiniciar Leitor externo	Comando enviado para reiniciar leitor externo.
Atualizar o firmware do equipamento	Comando enviado para realizar o update de firmware da central MCP.
Atualizar o firmware de leitor externo	Comando enviado para realizar o update de firmware de Leitor externo.
Buscar configuração de leitor externo	Comando enviado para ler a configuração de um Leitor externo o update de firmware da central MCP.
Configurar leitor externo	Comando enviado para configurar um Leitor externo.
Atualizar usuários de leitor externo	Comando enviado para atualizar os usuários de um Leitor externo a partir do equipamento mestre.
Apagar todos usuários de um leitor externo	Comando enviado para remover TODOS os usuários de um Leitor externo.
Buscar Data/Hora atual do equipamento	Comando enviado para solicitar DATA e HORA atual da central MCP.
Configurar Data/Hora do equipamento	Comando enviado configurar a DATA e HORA atual da central MCP.
Buscar Lista de acesso	Comando utilizado para buscar a lista de acesso realizados na central MCP.
Remover lista de acesso	Comando utilizado para remover a lista de acesso realizados na central MCP.
Buscar Contadores	Comando utilizado solicitar a lista de contadores/estatísticas da central MCP.
Buscar Resumo de Usuários	Comando utilizado solicitar lista com total de usuários e permissões de acesso.
Buscar configuração de alarmes	Comando utilizado buscar as configurações da central de alarmes do MCP.
Configurar Alarme	Comando configurar um alarme na central de alarmes do MCP.
Buscar Logs de alarmes	Comando utilizado para buscar os registros de alarmes do MCP.
Remover Logs de alarmes	Comando utilizado para remover os registros de alarmes do MCP.
Get QR Code - Dinâmico/Temporário	Comando utilizado solicitar um novo QR Code dinâmico/temporário ao MCP.
Solicitar configurações de Vídeo	Comando enviado para solicitar as URLs de vídeo da câmera configurado na central MCP.

Eventos

Eventos enviados pela central MCP para a Aplicação
Evento keepalive	Evento enviado pela central MCP para o servidor/aplicação para supervisão da conexão.
Evento de relê	Evento enviado pela central MCP informando status estado de relê.
Evento de relê Auxiliar	Evento enviado pela central MCP informando estados dos relês auxiliares RLAUX1, RLAUX2 e RLAUX3 .
Evento de Sensor	Evento enviado pela central MCP informando status estado de sensor das interfaces de acionamento READER1, READER2, READER3, READER4 e interfaces de acionamento/leitores externos.
Evento de Sensor Auxiliar	Evento enviado pela central MCP informando status estado de sensor auxiliar SAUX1, SAUX2, SAUX3, SAUX4, SAUX5 e SAUX6.
Evento de Sensor de Alarme	Evento enviado pela central MCP informando status estado de sensor de alarme SALM.
Evento de botoeira	Evento enviado pela central MCP informando estado das botoeiras BNT1 (READER1), BNT2 (READER2), BNT3 (READER3) e BNT4 (READER4).
Evento de Arrombamento	Evento enviado pela central MCP informando que foi detecção de arrombamento de porta.
Evento Input	Evento enviado pela central MCP informando status entrada no relê auxiliar.
Evento Output	Evento enviado pela central MCP informando status saída no relê auxiliar
Evento Mifire / NFC	Evento enviado pela central MCP informando status de cartão lido.
Evento RF433 Code	Evento enviado pela central MCP informando status de cartão/controle RF 433 lido.
Evento VCard Code	Evento enviado pela central MCP informando status de cartão veicular lido.
Evento Fingerprint	Evento enviado pela central MCP informando status de biometria lida.
Evento Fingerprint Status (Enrolment)	Evento enviado pela central MCP informando o status de cadastro de uma biometria (Enrolment).
Evento de Usuário e Senha	Evento enviado pela central MCP informando nova requisição de acesso por usuário e senha.
Evento QR Code	Evento enviado pela central MCP informando status de leitura de QR Code.
Evento Add User	Evento enviado pela central MCP informando que um novo usuário foi adicionado.
Evento Del User	Evento enviado pela central MCP informando que um usuário foi removido.
Evento de Cadastro Automático de Usuário	Evento enviado pela central MCP 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 pela central MCP informando o status da remoção automática de usuário (enviado após o comando eraseuser.
Evento de Alarme	Evento enviado pela central MCP informando novo status de alarme.
Evento Pânico	Evento enviado pela central MCP informando status da função pânico.
Evento de Chamada	Evento enviado pela central MCP informando um novo status de chamada.
Evento de Boot	Evento enviado pela central MCP informando Boot da central MCP.
Evento na Central de Alarmes	Evento enviado pela central MCP informando evento na central de alarmes.
Evento Sensor de Loop	Evento enviado pelo leitor informando status do sensor de corrente de loop.

---

Voltar