MCP/API/ReaderSetConfig

Tabela de conteúdo

1 Comando
- 1.1 JSON enviado para o porteiro Leitor MLI
- 1.2 JSON enviado para o porteiro Porteiro MPI
2 Exemplo
3 PHP

O comando Configurar Leitor Externo é utilizado alterar as configurações básicas de um leitor externo conectado ao MCP.

Comando

MÉTODO: POST

Parâmetros enviados para a central MCP
request	readersetconfig
interface	Identificação do leitor (5 a 32). Ver Leitores

POST-DATA: para cada equipamento é diferente.

JSON enviado para o porteiro Leitor MLI

Parâmetros enviados para a central MCP via JSON
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_user	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
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	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).

JSON enviado para o porteiro Porteiro MPI

Parâmetros enviados para a central MCP via JSON
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.
server	Endereço do servidor SIP/PABX.
port	Porta do servidor SIP/PABX.
stun	Endereço do servidor STUN.
exten	ID/Identificação/login do ramal do porteiro.
password	Senha ramal do porteiro.
hotline	Numero destino do botão portaria.
volmicrophone	Volume do microfone. (0 a 20)
volspeaker	Volume/Ganho do alto-falante. (0 a 20)
keyboard	Habilita ou Desabilita o teclado numérico (se houver) true: Habilita false: Desabilita
http_server	Endereço IP do servidor que receberá os eventos da API.
http_port	Porta do servidor que receberá os eventos da API.
http_username	Usuário de acesso ao servidor que receberá os eventos da API.
http_password	Senha de acesso ao servidor que receberá os eventos da API.
http_url	URL que deverá ser utilizado no envio dos eventos da API. Ex. Valor: /app/evts. O porteiro irá enviar os eventos para: http://ip:porta/app/evts/?...
http_timeout	Timeout de conexão do Porteiro no servidor.
http_retries	Número de tentativas de envio dos eventos para o servidor.
http_ssl	Indica se a conexão com o servidor será HTTPS. true: HTTPS habilitado false: HTTPS Desabilitado
httpd_username	Usuário para conexão de servidor externo na API do Porteiro.
httpd_password	Senha para conexão de servidor externo na API do Porteiro.
httpd_porta	Porta utilizado para conexão de servidor externo na API do Porteiro.
httpd_timeout	Timeout de conexão HTTP na API do Porteiro.
httpd_auth	Indica se a conexão com o servidor será HTTPS. true: Autenticação habilitada false: Autenticação Desabilitada
interface1_control_enable	Habilitar/Desabilitar Acionamento (Relê) da Interface 1. true: Habilita. false: Desabilita.
interface1_control_type	Tipo de Acionamento da Interface 1: 0: Contínuo. 1: Pulsado. 2: Manual.
interface1_control_time	Tempo de acionamento da interface 1 (segundos)
interface1_control_acc_time	Tempo de acionamento da interface 1 para acessibilidade (segundos).
interface1_interlocking	Habilitar/Desabilitar intertravamento na interface 1. true: Habilita. false: Desabilita.
interface1_sensor_enable	Habilitar/Desabilitar sensor da interface 1. true: Habilita. false: Desabilita.
interface1_sensor_panic	Habilitar/Desabilitar função pâncio no sensor da interface 1. true: Habilita. false: Desabilita.
interface1_sensor_alarm	Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado). true: Habilita. false: Desabilita.
interface1_alarm_sound	Habilita a reprodução ni porteiro de alarmes e eventos de acesso. true: Habilita. false: Desabilita.
interface1_sensor_breakin	Habilitar/Desabilitar alarme de arrombamento na Interface 1. true: Habilita. false: Desabilita.
interface1_button_enable	Habilitar/Desabilitar botoeira na interface 1. true: Habilita. false: Desabilita.
interface1_button_panic	Habilitar/Desabilitar função pânico na botoeira na interface 1. true: Habilita. false: Desabilita.
interface1_button_relay	Habilitar/Desabilitar acionamento da botoeira na interface 1. true: Habilita. false: Desabilita.
interface1_button_interface	Interface de acionamento da botoeira na interface 1. 0: Ambas 1: Interface 1 2: Interface 2
interface2_control_enable	Habilitar/Desabilitar Acionamento (Relê) da Interface 1. true: Habilita. false: Desabilita.
interface2_control_type	Tipo de Acionamento da Interface 1: 0: Contínuo. 1: Pulsado. 2: Manual.
interface2_control_time	Tempo de acionamento da interface 1 (segundos)
interface2_control_acc_time	Tempo de acionamento da interface 1 para acessibilidade (segundos).
interface2_interlocking	Habilitar/Desabilitar intertravamento na interface 1. true: Habilita. false: Desabilita.
interface2_sensor_enable	Habilitar/Desabilitar sensor da interface 1. true: Habilita. false: Desabilita.
interface2_sensor_panic	Habilitar/Desabilitar função pâncio no sensor da interface 1. true: Habilita. false: Desabilita.
interface2_sensor_alarm	Tempo, em segundos, para alarme no sensor de porta aberta da interface 1 (0 - Desabilitado). true: Habilita. false: Desabilita.
interface2_alarm_sound	Habilita a reprodução ni porteiro de alarmes e eventos de acesso. true: Habilita. false: Desabilita.
interface2_sensor_breakin	Habilitar/Desabilitar alarme de arrombamento na Interface 1. true: Habilita. false: Desabilita.
interface2_button_enable	Habilitar/Desabilitar botoeira na interface 1. true: Habilita. false: Desabilita.
interface2_button_panic	Habilitar/Desabilitar função pânico na botoeira na interface 1. true: Habilita. false: Desabilita.
interface2_button_relay	Habilitar/Desabilitar acionamento da botoeira na interface 1. true: Habilita. false: Desabilita.
interface2_button_interface	Interface de acionamento da botoeira na interface 1. 0: Ambas 1: Interface 1 2: Interface 2

Exemplo

POST /?request=readersetconfig&interface=3 HTTP/1.1
Content-Type: application/json
Content-Length: 167

{
  "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"
}

Resposta:

400 => Parâmetros incorretos
401 => Erro de autenticação da API
200 => OK

PHP

<?php
 
$user = "utech";
$pass = "1234";
$port = "8080";
$ipaddr = "10.0.0.1";
 
$data array(
{
    "serial"        => "0000005555",
    "mac"           => "F8:E7:B5:00:0B:3F",
    "dhcp"          => "off",
    "ip"            => "10.0.0.1",
    "netmask"       => "255.255.255.0",
    "gateway"       => "10.0.0.3",
    "dns"           => "8.8.8.8",
    "ntp"           => "",
    "server"        => "10.0.0.2",
    "port"          => "5060",
    "stun"          => "",
    "exten"         => "7000",
    "password"      => "1234",
    "hotline"       => "98",
    "volmicrophone" => "15",
    "volspeaker"    => "18",
    "keyboard"      => "true"
);
 
$data_string = json_encode($data);
$url = "$ipaddr:$port?request=setconfig";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, "$user:$pass");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");    
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data_string))
);                                           
 
$result = curl_exec($ch);
if(!$result) {
    echo "error!\n";
    return 2;
}
 
$fs = preg_replace("/<html><body>/", "", "$result");
$rc = preg_replace("/<\/body><\/html>/", "", "$fs");
 
switch($rc) {
 
    case "400":
        echo "400 => Parametros Invalidos\n";
    break;
 
    case "401":
        echo "401 => Erro de autenticação da API\n";
    break;
 
    case "200":
        echo "200 => OK\n";
    break;
 
    default:
        echo "Return Code: $rc\n";
}
 
?>

Voltar

MCP/API/ReaderSetConfig

Tabela de conteúdo

Comando

JSON enviado para o porteiro Leitor MLI

JSON enviado para o porteiro Porteiro MPI

Exemplo

PHP

Ferramentas pessoais

Espaços nominais

Variantes

Visualizações

Ações

Pesquisar

Navegação

Ferramentas