MLI/API/CmdGetConfig

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

Tabela de conteúdo


O comando Buscar Configuração é utilizado solicitar as configurações básicas do leitor.

Comando


MÉTODO: GET

Parâmetros enviados para o Leitor
request getconfig
Resposta enviada pelo o Leitor
model Informação do modelo do equipamento.
serial Numero de série do equipamento.
mac Endereço MAC do leitor.
hotspot Indica se o modo hotspot está ativo.
  • on: Habilitado
  • off: Desabilitado
ap_mode Indica se o modo Access Point esta habilitado.
  • on: Habilitado
  • off: Desabilitado
standalone Indica se o modo standalone esta habilitado.
  • on: Habilitado
  • off: Desabilitado
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.
  • on: Habilitado
  • off: Desabilitado
dhcp Identifica se o cliente dhcp está habilitado.
  • on: Habilitado
  • off: Desabilitado
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.
  • on: Habilitado
  • off: Desabilitado
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:
  • X: Mês inicial do horário de verão. Utilizar a faixa de 1 a 12, onde 1 é janeiro e 12 é dezembro.
  • Y: Semana do mês de inicio do horário de verão. Utilizar valores de 1 a 6, onde a primeira semana é representada por 1.
  • Z: Dia da semana de inicio do horário de verão. Utilizar valores de 0 a 6, onde:
    • 0: Domingo
    • 1: Segunda-feira
    • 2: Terça-feira
    • 3: Quarta-feira
    • 4: Quinta-feira
    • 5: Sexta-feira
    • 6: Sábado
  • T: Mês final do horário de verão. Utilizar a faixa de 1 a 12, onde 1 é janeiro e 12 é dezembro.
  • V: Semana do mês de inicio do horário de verão. Utilizar valores de 1 a 6, onde a primeira semana é representada por 1.
  • W: Dia da semana final do horário de verão. Utilizar valores de 0 a 6, onde:
    • 0: Domingo
    • 1: Segunda-feira
    • 2: Terça-feira
    • 3: Quarta-feira
    • 4: Quinta-feira
    • 5: Sexta-feira
    • 6: Sábado
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. 0 - Continuo / 1 - Manual.
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
rs485 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 Endereço IP/servidor e porta destino para envio do log/debug do leitor.
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).

Exemplo 

http://ip:porta/?request=getconfig

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
 
{
    "serial":"0000001234",
    "mac":"f8:e7:b5:01:02:03",
    "hotspot":"off",
    "ap_mode":"off",
    "standalone":"on",
    "ssid":"uTech",
    "password":"1234",
    "ssid_hidden":"off",
    "dhcp":"on",
    "ip":"10.0.0.1",
    "netmask":"255.255.255.0",
    "gateway":"10.0.0.2",
    "dns":"10.0.0.1",
    "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":"utech",
    "server_password":"1234",
    "server_url":"",
    "ota_url":"http://utech.com.br/firmware/ulip-1.1.2/MLI-1WQB/",
    "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://utech:1234@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.5:999",
    "control_acc_timeout":"30000",
    "rfid_panic_timeout":"0",
    "qrcode_panic_timeout":"0",
    "channel":"1",
    "beacon_interval":"100",
    "fingerprint_identify":"2"
}



PHP 

<?php
 
$user = "utech";
$pass = "1234";
$port = "8080";
$ipaddr = "10.0.0.1";
 
$url = "";
$url = "$ipaddr:$port?request=getconfig";
$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));
?>




Voltar

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

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