MPI/API/EvtQRCode

De uTech Tecnologia
(Diferença entre revisões)
Ir para: navegação, pesquisa
(→‎Evento)
(→‎Evento com Resposta Built-in)
 
(5 edições intermediárias de um usuário não apresentadas)
Linha 49: Linha 49:
 
* '''200''' => OK.
 
* '''200''' => OK.
  
 +
<br/><br/>
 +
=== Buitl-in Respose  ===
 +
 +
No próprio evento, é possível executar outros comandos, inserindo no corpo da resposta, no caso '''200 OK''' enviado pela aplicação, um ''array'' com os dados do comando a ser executado. Os parâmetros aceiros são descritos abaixo:
 +
 +
{| class="wikitable" width="65%"
 +
! align="center" colspan="2" | Parâmetros enviados para o Porteiro
 +
|-
 +
| align="left"| request || Comando a ser enviado. Comandos aceitos: '''relay''' ou '''play'''.
 +
|-
 +
| align="left"| interface || '''Para relay''': Define qual relê será habilitado ou desligado
 +
* '''0''': Ambas interfaces (1 e 2).
 +
* '''1''': Interface 1.
 +
* '''2''': Interface 2.
 +
|-
 +
| align="left"| state || '''Para relay''':  Define o estado do relê:
 +
* '''on:''' => Ligado
 +
* '''off:''' => Desligado
 +
* '''hold:''' => Mantem aberta porta/relê até receber um evento '''off''' da API ou um comando externo (ex. interface WEB, DTMF).
 +
|-
 +
| align="left"| message || '''Para play''':  Define a mensagem a reproduzir. Ver mensagens na documentação do comando [[MPI/API/PlayMessage|'''PlayMessage''']]
 +
|}
 +
 +
'''Exemplo - acionando o relê para abertura da interface 1''':
 +
{| class="wikitable"
 +
! style="text-align: left; font-weight: bold;" | <pre>HTTP/1.1 200 OK
 +
Content-Type: application/json
 +
Content-Length: 167
 +
{
 +
  "request"  :"relay",
 +
  "interface": "1",
 +
  "state"    :"on"
 +
}
 +
</pre>
 +
|}
 +
 +
 +
 +
'''Exemplo - acionando o relê para abertura da interface 1 e reproduzindo a mensagem de ''acesso liberado''''':
 +
{| class="wikitable"
 +
! style="text-align: left; font-weight: bold;" | <pre>HTTP/1.1 200 OK
 +
Content-Type: application/json
 +
Content-Length: 167
 +
 +
[
 +
  {
 +
  "request"  :"relay",
 +
  "interface": "1",
 +
  "state"    :"on"
 +
  },
 +
  {
 +
  "request" :"play",
 +
  "message" :"access_allowed"
 +
  }
 +
]
 +
 +
</pre>
 +
|}
 
<br/><br/>
 
<br/><br/>
  
Linha 78: Linha 136:
  
 
<br/>
 
<br/>
 +
<br/>
 +
== Evento com Resposta Built-in ==
 +
 +
{| class="wikitable" width="65%"
 +
|
 +
<source lang="php">
 +
<?php
 +
 +
$vars = $_REQUEST;
 +
 +
if(!isset($vars))
 +
        exit(0);
 +
 +
if(isset($vars['request']) && strcmp($vars['request'],"card") == 0)
 +
        $event = $vars['request'];
 +
else {
 +
        exit(1);
 +
}
 +
 +
# Dados recebido no evevento do porteiro
 +
#printf("Evento: %s<BR>\n", $vars['request']);
 +
#printf("=>  Card: %s<BR>\n", $vars['card']);
 +
#printf("=> State: %s<BR>\n", $vars['state']);
 +
#printf("=>  Time: %s<BR>\n", $vars['time']);
 +
#printf("=>  Key: %s<BR>\n", $vars['key']);
 +
 +
 +
## Verificar se o QR Code tem acesso e responder com o comando de liberação (relay) mais o comando de play (acesso liberado).
 +
##
 +
 +
$data = array (
 +
                0 => array ('request'  => 'relay',
 +
                            'interface' => '1',
 +
                            'state'    => 'on'),
 +
 +
                1 => array ('request' => 'play',
 +
                            'message' => 'access_allowed'),
 +
);
 +
 +
header('Content-type: application/json');
 +
echo json_encode( $data );
 +
 +
?>
 +
 +
</source>
 +
|}
 +
 
<br/>
 
<br/>
 
<br/>
 
<br/>
 
[[MPI/API#Eventos|'''Voltar''']]
 
[[MPI/API#Eventos|'''Voltar''']]
 
-----
 
-----

Edição atual tal como 14h08min de 30 de julho de 2019

Tabela de conteúdo


O Evento QR Code é enviado do porteiro para a aplicação, informando evento de de leitura de QR Code.

[editar] Evento

Parâmetros enviados pelo Porteiro
request qrcode
qrcode Identificação do QR Code
state Status da leitura/evento
  • blocked: QR Code bloqueado.
  • granted: QR Code liberado.
  • detected: QR Code detectado. Enviado quando o equipamento não está configurado no modo stadalone. Evento é repassado para a aplicação de terceiros.
  • doublepass: Passagem dupla detectada (Utilizado para controle de dupla passagem).
interface Identificação da interface acessada/acionada.
  • 0: Interface de acionamento 1 e 2 do porteiro (Quando selecionado para acionamento simultâneo das interfaces 1 e 2)
  • 1: Interface de acionamento 1 do porteiro.
  • 2: Interface de acionamento 2 do porteiro.
  • 3 a 32: Interface de acionamento externo. Leitor ou Porteiro slave. Ver Leitores Externos
key Chave primária do usuário.
time Data/Hora do evento no formato ddmmYYYYHHMMSS onde:
  • dd: Dia do mês. (01 a 31)
  • mm: Mês do ano. (01 a 12).
  • YYYY: Ano no formato 1970.
  • HH: Hora do dia no formato 24H. (00 a 23).
  • MM: Minuto da hora. (00 a 59).
  • SS: Segundo. (00 a 59).

[editar] Exemplo 

http://ip:porta/url/?request=qrcode&qrcode=E4385FD21AC&interface=1&state=blocked&key=4swed22g5

Resposta: A aplicação deve responder:

  • 401 => Erro de Autenticação.
  • 200 => OK.



[editar] Buitl-in Respose

No próprio evento, é possível executar outros comandos, inserindo no corpo da resposta, no caso 200 OK enviado pela aplicação, um array com os dados do comando a ser executado. Os parâmetros aceiros são descritos abaixo:

Parâmetros enviados para o Porteiro
request Comando a ser enviado. Comandos aceitos: relay ou play.
interface Para relay: Define qual relê será habilitado ou desligado
  • 0: Ambas interfaces (1 e 2).
  • 1: Interface 1.
  • 2: Interface 2.
state Para relay: Define o estado do relê:
  • on: => Ligado
  • off: => Desligado
  • hold: => Mantem aberta porta/relê até receber um evento off da API ou um comando externo (ex. interface WEB, DTMF).
message Para play: Define a mensagem a reproduzir. Ver mensagens na documentação do comando PlayMessage

Exemplo - acionando o relê para abertura da interface 1: 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 167
{
  "request"  :"relay",
  "interface": "1",
  "state"    :"on" 
}


Exemplo - acionando o relê para abertura da interface 1 e reproduzindo a mensagem de acesso liberado: 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 167

[
  {
   "request"  :"relay",
   "interface": "1",
   "state"    :"on" 
  },
  {
   "request" :"play",
   "message" :"access_allowed"
  }
]



[editar] PHP 

<?php
 
$vars = $_REQUEST;
 
if(!isset($vars))
        exit(0);
 
if(isset($vars['request']) && strcmp($vars['request'],"qrcode") == 0)
        $event = $vars['request'];
else {
        echo "Evento invalido!\n";
        exit(1);
}
 
printf("Evento: %s<BR>\n", $vars['request']);
printf("=>  Card: %s<BR>\n", $vars['qrcode']);
printf("=> State: %s<BR>\n", $vars['state']);
printf("=>   Key: %s<BR>\n", $vars['key']);
?>



[editar] Evento com Resposta Built-in 

<?php
 
$vars = $_REQUEST;
 
if(!isset($vars))
        exit(0);
 
if(isset($vars['request']) && strcmp($vars['request'],"card") == 0)
        $event = $vars['request'];
else {
        exit(1);
}
 
# Dados recebido no evevento do porteiro
#printf("Evento: %s<BR>\n", $vars['request']);
#printf("=>  Card: %s<BR>\n", $vars['card']);
#printf("=> State: %s<BR>\n", $vars['state']);
#printf("=>  Time: %s<BR>\n", $vars['time']);
#printf("=>   Key: %s<BR>\n", $vars['key']);

 
## Verificar se o QR Code tem acesso e responder com o comando de liberação (relay) mais o comando de play (acesso liberado).
##

$data = array (
                0 => array ('request'   => 'relay',
                            'interface' => '1',
                            'state'     => 'on'),
 
                1 => array ('request' => 'play',
                            'message' => 'access_allowed'),
);
 
header('Content-type: application/json');
echo json_encode( $data );
 
?>



Voltar

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

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