MPI/API/ReaderGetConfig
De uTech Tecnologia
(Diferença entre revisões)
(Criou página com ' __TOC__ O comando '''Buscar Configuração de Leitor''' é utilizado solicitar as configurações básicas de um leitor conectado ao porteiro. == Comando == <BR> {| class=...') |
|||
(8 edições intermediárias de um usuário não apresentadas) | |||
Linha 5: | Linha 5: | ||
== Comando == | == Comando == | ||
+ | |||
+ | '''MÉTODO:''' <span style="color:red">'''GET'''</span> | ||
+ | |||
+ | {| class="wikitable" width="75%" | ||
+ | ! align="center" colspan="2" | Parâmetros enviados para o Porteiro | ||
+ | |- | ||
+ | | align="left"| '''request''' || '''readergetconfig''' | ||
+ | |- | ||
+ | | align="left"| '''interface''' || Identificação do leitor (3 a 20). '''Campo Obrigatório'''. | ||
+ | |} | ||
<BR> | <BR> | ||
Linha 84: | Linha 94: | ||
| align="left"| server_user || Usuário de acesso à API de integração do Leitor. | | align="left"| server_user || Usuário de acesso à API de integração do Leitor. | ||
|- | |- | ||
− | | align="left"| | + | | align="left"| server_password || Senha de acesso à API de integração do Leitor. |
|- | |- | ||
| align="left"| ota_url || URL para atualização de firmware. | | align="left"| ota_url || URL para atualização de firmware. | ||
|- | |- | ||
− | | align="left"| rfid || Indica se o leitor RFID/NFC está habilitado. (''' | + | | align="left"| rfid || Indica se o leitor RFID/NFC está habilitado. ('''on'''/'''off'''). |
|- | |- | ||
| align="left"| rfid_timeout || Timeout de leitura RFID/NFC. | | align="left"| rfid_timeout || Timeout de leitura RFID/NFC. | ||
|- | |- | ||
− | | align="left"| rfid_nfc || Indica se NFC móvel está habilitado. (''' | + | | align="left"| rfid_nfc || Indica se NFC móvel está habilitado. ('''on'''/'''off'''). |
|- | |- | ||
− | | align="left"| qrcode || Indica se o leitor '''QR Code''' está habilitado. (''' | + | | align="left"| qrcode || Indica se o leitor '''QR Code''' está habilitado. ('''on'''/'''off'''). |
|- | |- | ||
| align="left"| qrcode_timeout || Timeout de dos '''QR Codes'''. | | align="left"| qrcode_timeout || Timeout de dos '''QR Codes'''. | ||
|- | |- | ||
− | | align="left"| control_mode || Tipo de acionamento do rele. 0 | + | | align="left"| control_mode || Tipo de acionamento do rele. |
+ | * '''0''': Continuo | ||
+ | * '''1''': Manual | ||
|- | |- | ||
| align="left"| control_timeout || Tempo de acionamento do rele | | align="left"| control_timeout || Tempo de acionamento do rele | ||
Linha 126: | Linha 138: | ||
| align="left"| qrcode_config || Indica se o leitor está habilitado para ser configurado via QR Code ('''on''' / '''off'''). | | align="left"| qrcode_config || Indica se o leitor está habilitado para ser configurado via QR Code ('''on''' / '''off'''). | ||
|- | |- | ||
− | | align="left"| debug || Endereço IP/servidor e porta destino para envio do log/debug do leitor. | + | | align="left"| debug || Tipo, Nível, Endereço IP/servidor e porta destino para envio do log/debug do leitor. |
+ | '''Tipo:''' | ||
+ | * '''0''': Desabilitado | ||
+ | * '''2''': Habilitado | ||
+ | '''Nível:''' | ||
+ | * '''0''': Nenhum | ||
+ | * '''2''': Error | ||
+ | * '''3''': Critical | ||
+ | * '''4''': Warning | ||
+ | * '''5''': Message | ||
+ | * '''6''': Info | ||
+ | * '''7''': Debug | ||
+ | |||
+ | '''Exemplo''': ''2:6:10.0.0.222:8000'', onde o log está habilitado no modo '''Info''', endereço IP de destino '''10.0.0.222''' e porta '''8000''' | ||
|- | |- | ||
| align="left"| control_acc_timeout || Tempo de acionamento do rele para '''acessibilidade''' Em milissegundos. | | align="left"| control_acc_timeout || Tempo de acionamento do rele para '''acessibilidade''' Em milissegundos. | ||
Linha 134: | Linha 159: | ||
| align="left"| qrcode_panic_timeout || Timeout para Pânico no Leitor QR Code. Em milissegundos. | | align="left"| qrcode_panic_timeout || Timeout para Pânico no Leitor QR Code. Em milissegundos. | ||
|- | |- | ||
− | | align="left"| channel || Canal utilizado na rede WIFI ('''1''' a | + | | align="left"| channel || Canal utilizado na rede WIFI ('''1''' a '''13'''). |
|- | |- | ||
| align="left"| beacon_interval || Intervalo de tempo para envio dos '''beacon frames''. Em milissegundos. | | align="left"| beacon_interval || Intervalo de tempo para envio dos '''beacon frames''. Em milissegundos. | ||
Linha 140: | Linha 165: | ||
| align="left"| fingerprint_identify || Quantidade de vezes que o sensor biométrico tentará verificar a identidade na leitura ('''1''' a '''5'''). | | align="left"| fingerprint_identify || Quantidade de vezes que o sensor biométrico tentará verificar a identidade na leitura ('''1''' a '''5'''). | ||
|} | |} | ||
− | |||
== Exemplo == | == Exemplo == | ||
{| class="wikitable" | {| class="wikitable" | ||
− | ! style="text-align: left; font-weight: bold;" | <pre>http://ip:porta/?request= | + | ! style="text-align: left; font-weight: bold;" | <pre>http://ip:porta/?request=readergetconfig&interface=3</pre> |
|} | |} | ||
Linha 164: | Linha 188: | ||
{ | { | ||
− | "serial":" | + | "model":"MLI-1WQB" |
− | "mac":" | + | "serial":"0000002874" |
− | "release":"1.1. | + | "mac":"f8:e7:b5:f1:f1:f1" |
− | " | + | "release":"1.1.3" |
− | " | + | "hotspot":"off" |
− | " | + | "ap_mode":"off" |
− | " | + | "standalone":"on" |
− | " | + | "ssid":"uTech-Test" |
− | " | + | "password":"adminutech" |
− | " | + | "ssid_hidden":"off" |
− | " | + | "dhcp":"on" |
− | " | + | "ip":"10.0.0.1" |
− | " | + | "netmask":"255.255.255.0" |
− | " | + | "gateway":"10.0.0.2" |
− | " | + | "dns":"10.0.0.2" |
− | " | + | "ntp":"pool.ntp.br" |
− | " | + | "hostname":"ulip" |
− | " | + | "timezone":"-3" |
− | " | + | "dst":"off" |
− | " | + | "dst_date":"10/3/0 2/3/0" |
− | " | + | "server":"10.0.0.3" |
− | " | + | "server_port":"8090" |
− | " | + | "server_user":"admin" |
− | " | + | "server_password":"admin" |
− | " | + | "server_url":"" |
− | " | + | "ota_url":"http://10.0.0.10" |
− | " | + | "rfid":"on" |
− | " | + | "rfid_timeout":"1000" |
− | " | + | "rfid_nfc":"on" |
− | " | + | "qrcode":"on" |
− | " | + | "qrcode_timeout":"1000" |
− | " | + | "control_mode":"0" |
− | " | + | "control_timeout":"3000" |
− | " | + | "control_external":"false" |
− | " | + | "control_url":"http://admin:admin@10.0.0.9:8080/?request=relay&interface=1&state=on" |
− | " | + | "rs485":"off" |
− | " | + | "rs485_address":"0" |
− | " | + | "rf433":"off" |
− | " | + | "fingerprint":"on" |
− | " | + | "fingerprint_timeout":"1000" |
− | " | + | "fingerprint_security":"3" |
− | " | + | "latitude":"" |
− | " | + | "longitude":"" |
− | " | + | "user_auth":"on" |
− | " | + | "qrcode_config":"on" |
− | " | + | "debug":"2:7:10.0.0.8:7777" |
− | " | + | "control_acc_timeout":"30000" |
− | " | + | "rfid_panic_timeout":"0" |
− | " | + | "qrcode_panic_timeout":"0" |
− | + | "channel":"1" | |
− | " | + | "beacon_interval":"100" |
+ | "fingerprint_identify":"2" | ||
} | } | ||
</source> | </source> | ||
Linha 233: | Linha 258: | ||
$url = ""; | $url = ""; | ||
− | $url = "$ipaddr:$port?request= | + | $url = "$ipaddr:$port?request=readergetconfig&interface=3"; |
$ch = curl_init($url); | $ch = curl_init($url); | ||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); | curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); |
Edição atual tal como 16h32min de 18 de março de 2019
Tabela de conteúdo |
O comando Buscar Configuração de Leitor é utilizado solicitar as configurações básicas de um leitor conectado ao porteiro.
[editar] Comando
MÉTODO: GET
Parâmetros enviados para o Porteiro | |
---|---|
request | readergetconfig |
interface | Identificação do leitor (3 a 20). Campo Obrigatório. |
Resposta enviada pelo o Leitor | |
---|---|
serial | Numero de série do equipamento. |
mac | Endereço MAC do leitor. |
hotspot | Indica se o modo hotspot está ativo.
|
ap_mode | Indica se o modo Access Point esta habilitado.
|
standalone | Indica se o modo standalone esta habilitado.
|
ssid | Informa o SSID/rede configurado no Access Point. |
password | Senha de acesso a rede WIFI. |
ssid_hidden | Identifica se está configurado para esconder ou não SSID da rede WIFI.
|
dhcp | Identifica se o cliente dhcp está habilitado.
|
ip | Endereço IP do leitor. |
netmask | Endereço da mascara de rede do leitor. |
gateway | Endereço da rota padrão do leitor. |
dns | Endereço do servidor DNS primário do leitor. |
ntp | Endereço do servidor NTP do leitor. |
hostname | Hostname do leitor. |
timezone | Timezone configurado no leitor. |
dst | Indica se o horário de verão está habilitado.
|
dst_date | Data de inicio e final do horário de verão. Ex: 10/3/0 2/3/0. O formato é definido por duas sequencias, onde a primeira é a data inicial e a segunda é a data final do horário de verão. => X/Y/Z T/V/W, onde:
|
server | Endereço IP do servidor de integração, PABX ou porteiro uTech. |
server_port | Porta do servidor de integração, PABX uTech (Padrão do PABX uTech - 8090) ou porteiro uTech (Configurado em Configuração do servidor de integração no MPI). |
server_user | Usuário de acesso à API de integração do Leitor. |
server_password | Senha de acesso à API de integração do Leitor. |
ota_url | URL para atualização de firmware. |
rfid | Indica se o leitor RFID/NFC está habilitado. (on/off). |
rfid_timeout | Timeout de leitura RFID/NFC. |
rfid_nfc | Indica se NFC móvel está habilitado. (on/off). |
qrcode | Indica se o leitor QR Code está habilitado. (on/off). |
qrcode_timeout | Timeout de dos QR Codes. |
control_mode | Tipo de acionamento do rele.
|
control_timeout | Tempo de acionamento do rele |
control_external | Indica se o acionamento de relé externo está acionado. true ou false. |
control_url | URL para acionamento externo. Ex: http://utech:1234@10.0.0.1:8080/request=relay&interface=1&state=on |
rs488 | Indica se a interface RS-485 está ativa ('on / off). |
rs485_address | Endereço da interface RS-485. 1 a 15. |
rf433 | Indica se a interface RS-485 está ativa ('on / off). |
fingerprint | Indica se o leitor biométrico está ativo ('on / off). |
fingerprint_timeout | Timeout de leitura do sensor biométrico. |
fingerprint_security | Nível de segurança do leitor biométrico (1 a 5). |
latitude | Localização do leitor / latitude. |
longitude | Localização do leitor / longitude. |
user_auth | Indica se os usuários do leitor tem permissão para acessar a API (on / off). |
qrcode_config | Indica se o leitor está habilitado para ser configurado via QR Code (on / off). |
debug | Tipo, Nível, Endereço IP/servidor e porta destino para envio do log/debug do leitor.
Tipo:
Nível:
Exemplo: 2:6:10.0.0.222:8000, onde o log está habilitado no modo Info, endereço IP de destino 10.0.0.222 e porta 8000 |
control_acc_timeout | Tempo de acionamento do rele para acessibilidade Em milissegundos. |
rfid_panic_timeout | Timeout para Pânico no Leitor NFC. Em milissegundos. |
qrcode_panic_timeout | Timeout para Pânico no Leitor QR Code. Em milissegundos. |
channel | Canal utilizado na rede WIFI (1 a 13). |
beacon_interval | Intervalo de tempo para envio dos 'beacon frames. Em milissegundos. |
fingerprint_identify | Quantidade de vezes que o sensor biométrico tentará verificar a identidade na leitura (1 a 5). |
[editar] Exemplo
http://ip:porta/?request=readergetconfig&interface=3 |
---|
Resposta:
- 400 => Parâmetros incorretos
- 401 => Erro de autenticação da API
- 200 => OK
User-Agent: uTech/0000002874 Connection: close Date: Wed, 13 Jun 2018 17:22:35 Host: 10.0.0.2 Content-Type: application/json { "model":"MLI-1WQB" "serial":"0000002874" "mac":"f8:e7:b5:f1:f1:f1" "release":"1.1.3" "hotspot":"off" "ap_mode":"off" "standalone":"on" "ssid":"uTech-Test" "password":"adminutech" "ssid_hidden":"off" "dhcp":"on" "ip":"10.0.0.1" "netmask":"255.255.255.0" "gateway":"10.0.0.2" "dns":"10.0.0.2" "ntp":"pool.ntp.br" "hostname":"ulip" "timezone":"-3" "dst":"off" "dst_date":"10/3/0 2/3/0" "server":"10.0.0.3" "server_port":"8090" "server_user":"admin" "server_password":"admin" "server_url":"" "ota_url":"http://10.0.0.10" "rfid":"on" "rfid_timeout":"1000" "rfid_nfc":"on" "qrcode":"on" "qrcode_timeout":"1000" "control_mode":"0" "control_timeout":"3000" "control_external":"false" "control_url":"http://admin:admin@10.0.0.9:8080/?request=relay&interface=1&state=on" "rs485":"off" "rs485_address":"0" "rf433":"off" "fingerprint":"on" "fingerprint_timeout":"1000" "fingerprint_security":"3" "latitude":"" "longitude":"" "user_auth":"on" "qrcode_config":"on" "debug":"2:7:10.0.0.8:7777" "control_acc_timeout":"30000" "rfid_panic_timeout":"0" "qrcode_panic_timeout":"0" "channel":"1" "beacon_interval":"100" "fingerprint_identify":"2" } |
---|
[editar] PHP
<?php $user = "utech"; $pass = "1234"; $port = "8080"; $ipaddr = "10.0.0.1"; $url = ""; $url = "$ipaddr:$port?request=readergetconfig&interface=3"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass"); $result = curl_exec($ch); if(!$result) { echo "error!\n"; return 2; } print_r(json_decode($result, true)); ?> |