Parâmetros Configuração

Descrição dos parâmetros de configuração dos equipamentos:

general

Representa um usuário.

Campo Tipo Descrição
beep_enabled string Ativa o som de beep do equipamento. Valores: "0" ou "1".
relayN_enabled string Habilita o uso do relé N, onde N vai de 1 à 4 indicando o relé (o número máximo de relés depende do produto). Para desabilitar "0" e para habilitar "1".
relayN_timeout string Tempo de ativação do relé em milissegundos, onde N vai de 1 à 4 indicando o relé (o número máximo de relés depende do produto). Exemplo: "3000".
relayN_auto_close int A configuração do relay permite que seja configurado de duas formas neste caso N é o número da porta em questão (No caso do iDAccess pode ser 0 ou 1, no caso da catraca é sempre 0 enquanto a iDBox vai de 0 a 3) e a sua configuração pode ser "0" (Funcionamento normal) e "1" (Quando sensor de porta abrir, o relê fechará) - Evita que a porta fique aberta mais tempo do que o necessário.
door_sensorN_enabled string Habilita o uso do sensor de porta N, onde N vai de 1 à 4 indicando a porta (o número máximo depende do produto). Para desabilitar "0" e para habilitar "1".
door_sensorN_idle string Indica qual o nível lógico do sensor da porta N quando ela estiver fechada, onde N vai de 1 à 4 indicando a porta (o número máximo depende do produto). Valores: "0" ou "1".
doorN_interlock string Numero das portas que estão intertravadas separados por vírgula (ex: "1,3"), onde N vai de 1 à 4 indicando a porta (o número máximo depende do produto).
bell_enabled string Habilita ou desabilita a campainha.
bell_relay string Relê no qual a campainha está conectada, o padrão é "2".
catra_timeout string Tempo que a catraca fica liberada para um giro em ms. timeout igual a zero significa tempo infinito, ou seja, liberada até o próximo giro, Exemplo: "3000". Atenção: Esse método é especifico para a catraca.
local_identification string Esse parâmetro deve ser setado quando o equipamento está no modo enterprise e a identificação está sendo feita no próprio equipamento, os valores são "1" e "0".
exception_mode string Esse parâmetro deve ser setado quando o equipamento precisa permanecer com a entrada sempre liberada ou sempre bloqueada, as opções são emergency e lock_down. Para sair destes modos basta setar esta configuração para qualquer outro valor, o padrão é "". Quando emergency está habilitado o equipamento permanece com a entrada sempre liberada e a tela e identificações permanecem travadas. Quando lock_down está habilitado o equipamento permanece com a entrada sempre bloqueada e a tela e identificações permanecem travadas.
language string Usado para alterar o idioma do equipamento, os valores possíveis são: pt_BR (Português), spa_SPA (Espanhol) e en_US (Inglês). Após a alteração do idioma do equipamento é necessário reinicia-lo.
daylight_savings_time_start int A data de inicio do horário de verão (unix timestamp).
daylight_savings_time_end int A data de fim do horário de verão (unix timestamp).
catra_timeout string Tempo que a catraca fica liberada para um giro em ms. timeout igual a zero significa tempo infinito, ou seja, liberada até o próximo giro (aplicável somente quando o dispositivo for catraca).
password_only string Quando habilitado e no modo online, o equipamento pedirá somente a senha ao invés de pedir o ID e senha para identificação do usuário através da interface gráfica do dispositivo. O request new_user_id_and_password enviado pelo dispositivo não muda, o user_id irá zerado. Utilize os valores "1" ou "0" para habilitar ou desabilitar respectivamente.
hide_password_only string Quando é atribuindo o valor "0" para este parâmetro e password_only (descrito acima) esta habilitado, o equipamento não esconderá a senha que é digitada. O padrão é "1".
password_only_tip string Esta configuração muda o texto da dica que é mostrada quando password_only está habilitado. Quando vazio, mostra a mensagem padrão. O valor padrão é vazio.

catra

Configurações específicas da catraca.

Campo Tipo Descrição
anti_passback string Habilita ou desabilita o controle de anti-dupla entrada.
daily_reset string "0" ou "1". Habilita o reset de logs para o controle de anti-dupla entrada. Os acessos serão apagados todos os dias a meia-noite.
gateway string Sentido da entrada. Deve ser "clockwise" ou "anticlockwise" (horário ou anti-horário respectivamente).
operation_mode string Modo de operação da catraca. Controla quais sentidos da catraca serão controlados ou liberados. Deve ser "blocked", "entrance_open", "exit_open", "both_open" (Ambas controladas, entrada liberada, saída liberada e ambas liberadas respectivamente).

opening_times

Essa configuração permite definir qual o tempo de abertura da porta em milissegundos.

Campo Tipo Descrição
id int 64 Identificador único da regra de tempo de abertura especial.
user_id int 64 Inteiro indicando o usuário (referência a tabela users).
door_id int 64 Inteiro indicando a porta (valor inicial 1).
time int Tempo diferenciado de abertura em milissegundos.

mifare

A configuração do modulo MIFARE permite que a quantidade de bits que a leitora do device vai ler seja configurável, podendo ser 24 ou 32 bits.

Campo Tipo Descrição
byte_order string O byte_order possui dois possíveis valores "W_26" (MIFARE c/ 24 bits de informação) usado para manter compatibilidade com plantas antigas e "LSB" (Least Significant Byte) onde lê 32 bits de dados e inverte a ordem dos bytes, qualquer configuração diferente de "W_26" irá operar no modo "LSB".
read_block string Indica qual bloco do cartão MIFARE será automaticamente lido quando aproximado do leitor. Quando vazio, nenhum bloco será lido. O padrão é vazio.
authentication_type string Tipo de chave que será usado para autenticação do bloco indicado por read_block. Pode ser "A" ou "B". Padrão vazio.
authentication_key string Valor em base64 de chave usada para autenticar o bloco indicado por read_block. Padrão vazio.

card_readerN

Configuração da entrada wiegand, card_readerN nesse caso o N significa o numero da wiegand in, por exemplo, o iDAccess é sempre zero, ou seja card_reader0, a iDBlock pode ter duas opções, podendo ser 0 para a wiegand principal e 1 para wiegand da urna, e a iDBox pode ter 4 opções, sendo de (0 a 3) correspondendo a quantidade de leitoras wiegand.

Campo Tipo Descrição
mode string A configuração mode, pode ter dois valores, "WIN" para wiegand e "MAG" para magstripe.
type int A configuração type, pode ter dois estados, LSB (Least Significant Byte). Quando a leitura for wiegand 34, inverte a ordem dos bytes qualquer outro valor("") a inversão não será realizada.

alarm

Parâmetros de configuração de alarme do equipamento.

Campo Tipo Descrição
door_sensor_enabled string Habilita ou desabilita o sensor de porta. Os valores possíveis são "0" ou "1" para habilitar e desabilitar respectivamente.
door_sensor_delay string Define o tempo em segundos em que a porta deverá permanecer aberta antes que o alarme de porta aberta seja gerado. O valore padrão é "5".
forced_access_enabled string Habilita ou desabilita a detecção de arrombamento de porta. Os valores possíveis são "0" ou "1" para habilitar e desabilitar respectivamente.
siren_enabled string Habilita ou desabilita a sirene (aplicável apenas para o iDAccess). Os valores possíveis são "0" ou "1" para habilitar e desabilitar respectivamente.
siren_relay string Relê no qual a sirene está conectada, o padrão é "2" (aplicável apenas para o iDAccess).

identifier

Configurações do identificador.

Campo Tipo Descrição
verbose_logging string Se ativado, registra todos os tipos de acesso, inclusive não identificados. Utiliza mais memória. Se desativado, registra apenas acessos autorizados e não-autorizados. Valores: "0" ou "1".
log_type bool Esta configuração só é válida para o iDFlex ponto. (Apesar dela existir para os outros dispositivos) e determina se as batidas customizadas estão habilitadas. (Tipos de batidas)
multi_factor_authentication int Esta configuração determina se a autenticação múltipla deve ser utilizada:

0 = Desabilitado
1 = Cartão + Biometria
2 = Cartão + Senha

bio_id

Configurações da biometria do equipamento.

Campo Tipo Descrição
similarity_threshold_1ton string Quanto maior o numero setado, mais rigorosa será a identificação. Aumentar este número irá diminuir a taxa de falsas aceitações e aumentar a taxa de falsas rejeições, diminuí-la terá o efeito inverso. Valor padrão: "12300".

online_client

Configurações do client (equipamento) quando em modo enterprise.

Campo Tipo Descrição
server_id int 64 Id do servidor de acesso na tabela devices, que indica para quem será enviado os eventos de identificação.
extract_template string Configura se, em caso de identificação por biometria, o equipamento irá extrair o template da digital e enviá-lo ou se irá enviar a imagem da digital. Valores: "0" ou "1".
contingency_enabled bool Indica se o terminal deve ou não entrar em contingência quando houver falha na comunicação com o servidor de acesso.
max_request_attempts int Quantidade de tentativas que o equipamento faz para se comunicar com o servidor antes de entrar no modo de contingência.
request_timeout int Indica o tempo de timeout em milissegundo que o dispositivo irá aguardar pela resposta das requisições.
alive_interval int Indica o intervalo de tempo em milissegundo em que dispositivo irá tentar voltar para o modo online quando em contingência (device_is_alive).

monitor

Parâmetros de configuração do Monitor.

Campo Tipo Descrição
request_timeout int O tempo em ms para o request dar timeout.
hostname string O endereço para onde a request será enviado, por exemplo, o IP do servidor.
port string A porta para onde a request será enviado.
path string Este parâmetro define o caminho que compõe o endpoint onde os eventos do monitor são notificados. A valor padrão deste parâmetro é "api/notifications".

sec_boxs

As configurações do modulo de acionamento externo (MAE/Security Box) usado no iDFlex, iDAccess Pro e iDAccess Nano, por estarem armazenadas em banco de dados, necessitam ser alteradas através do objeto sec_boxs, e manipuladas através das funções de manipulação de objetos.