MLI/API/CmdSetConfig
De uTech Tecnologia
Tabela de conteúdo |
O comando Configurar Leitor é utilizado alterar as configurações básicas do leitor.
Comando
MÉTODO: POST
Parâmetros enviados para o Leitor | |
---|---|
request | setconfig |
POST-DATA:
Parâmetros enviados para o Leitor via JSON | |
---|---|
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. Tamanho máximo 64 caracteres. Minimo 8 caracteres. |
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. Tamanho máximo 16 caracteres. |
netmask | Endereço da mascara de rede do leitor. Tamanho máximo 16 caracteres. |
gateway | Endereço da rota padrão do leitor. Tamanho máximo 16 caracteres. |
dns | Endereço do servidor DNS primário do leitor. Tamanho máximo 16 caracteres. |
ntp | Endereço do servidor NTP do leitor. Tamanho máximo 128 caracteres. |
hostname | Hostname do leitor. Tamanho máximo 20 caracteres. |
timezone | Timezone configurado no leitor. Valor numérico: -23 a 23. |
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:
|
web_password | Senha de acesso a interface WEB e API do Leitor. |
server | Endereço IP do servidor de integração, PABX ou porteiro uTech. Tamanho máximo 16 caracteres. |
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). Valor inteiro de 1 a 65355. |
server_user | Usuário de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 20 caracteres. |
server_password | Senha de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 20 caracteres. |
server_url | URL de acesso ao servidor de aplicação para a API enviar eventos. Tamanho máximo 128 caracteres. |
ota_url | URL para atualização de firmware. Tamanho máximo 80 caracteres. |
rfid | Indica se o leitor RFID/NFC está habilitado. (On/Off). |
rfid_timeout | Timeout de leitura RFID/NFC. Valor inteiro, de 0 a 4294967295 - em milissegundos. |
rfid_panic_timeout | Timeout de leitura RFID/NFC para Pânico. Valor inteiro, de 0 a 4294967295 - em milissegundos. |
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 leitura dos QR Code's. Valor inteiro, de 0 a 4294967295 - em milissegundos. |
qrcode_panic_timeout | Timeout de leitura dos QR Code's para Pânico. Valor inteiro, de 0 a 4294967295 - em milissegundos. |
control_mode | Tipo de acionamento do rele. 0 - Continuo / 1 - Manual. |
control_timeout | Tempo de acionamento do relé. Tempo inteiro, em segundos de 0 a 4294967295. |
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. Tamanho máximo 256 caracteres. |
rs485 | Indica se a interface RS-485 está ativa ('on / off). |
rs485_address | Endereço da interface RS-485. Valor inteiro de 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. Valor inteiro de 0 a 4294967295, em milissegundos |
fingerprint_security | Nível de segurança do leitor biométrico. Valor inteiro de 1 a 5. |
fingerprint_retries | Número de tentativas de leitura da biometria antes de enviar erro. |
latitude | Localização do leitor / latitude. Tamanho máximo 16 caracteres. |
longitude | Localização do leitor / longitude. Tamanho máximo 16 caracteres. |
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. Tamanho máximo 128 caracteres. |
control_acc_timeout | Tempo de acionamento do rele para acessibilidade Valor inteiro, em milissegundos de 0 a 4294967295. |
rfid_panic_timeout | Timeout para Pânico no Leitor NFC. Valor inteiro, em milissegundos de 0 a 4294967295. |
qrcode_panic_timeout | Timeout para Pânico no Leitor QR Code. Valor inteiro, em milissegundos de 0 a 4294967295. |
channel | Canal utilizado na rede WIFI. Valor inteiro de 1 a '13'. |
beacon_interval | Intervalo de tempo para envio dos 'beacon frames. Valor inteiro, em milissegundos de 0 a 65535. |
fingerprint_identify | Quantidade de vezes que o sensor biométrico tentará verificar a identidade na leitura. Valor interiro de 1 a 5. |
Exemplo
POST /?request=setconfig 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