Lista de Objetos

Veja abaixo a descrição de todos os objetos da linha de acesso, a lista identifica alguns dos diferentes tipos de recursos que você pode utilizar usando a API e também suporta métodos para inserir, atualizar, buscar e excluir muitos deles.

users

Representa um usuário.

Campo Tipo Descrição
id int 64 Identificador único de um usuário (obrigatório).
registration string Texto representando a matrícula de um usuário (obrigatório).
name string Texto contendo o nome de um usuário (obrigatório).
password string String que representa a senha do usuário após o processo de Hash (para definir esse parâmetro não se deve usar o texto simples digitado pelo usuário deve-se gerar seu Hash através do comando user_hash_password. Da mesma forma, a aquisição desse parâmetro através do comando load_objects retorna a senha após o Hash).
salt string String representando o Salt usado para calcular o Hash da senha do usuário.
begin_time int Inteiro representando a partir de que data e hora (unix timestamp) o usuário é válido.
end_time int Inteiro representando até que data e hora (unix timestamp) o usuário é válido.

templates

Dados biométricos das impressões digitais dos usuários (referidas a seguir como biometrias).

Campo Tipo Descrição
id int 64 Identificador único de uma biometria (obrigatório).
finger_position int Campo reservado.
finger_type int Tipo de biometria dedo comum valor 0 ou dedo de pânico valor 1 (obrigatório).
template string base 64 String em base 64 representando um template biométrico.
user_id int 64 Identificador único do usuário a quem essa biometria pretence (obrigatório).

cards

Representa os cartões de identificação por proximidade.

Campo Tipo Descrição
id int 64 Identificador único de uma cartão de identificação (obrigatório).
value unsigned int 64 Este campo indica a numeração do cartão, para cartões de proximidade (ASK, FSK, PSK), também chamados de Wiegand, o valor a ser enviado pela API é [parte antes da vírgula] * 2^32 + [parte depois da vírgula]. Exemplo: Para o cartão 123,45678 deve-se enviar o valor 123 * 2^32 + 45678, ou seja, 528281023086. Este também é o valor a ser recebido da API (obrigatório e único, não podem existir dois cartões com mesmo value no banco de dados).
user_id int 64 Identificador único do usuário ao qual pertence o cartão de identificação (obrigatório).

alarm_zones

Dados referentes às zonas de alarmes.

Campo Tipo Descrição
zone int Identificador único de uma zona de alarme (obrigatório).
enabled int Indica se a entrada de alarme referente à zona está habilitada (valor 1) ou não (valor 0) (obrigatório).
active_level int Indica se a entrada de alarme referente à zona esta configurada como 'ativo alto' (1) ou 'ativo baixo' (0) (obrigatório).
alarm_delay int Tempo de atraso no disparo do alarme uma vez que um sinal de alarme tenha sido detectado nesta zona (obrigatório).

user_roles

Relaciona usuários a níveis de privilégio. Contém apenas usuários que tenham algum nível de privilégio diferente do padrão.

Campo Tipo Descrição
user_id int 64 Identificador único do usuário (obrigatório).
role int Se este campo estiver definido como 1, o usuário é um administrador (obrigatório).

groups

Representa os grupos de acesso. Nas interfaces nativa do equipamento e na interface web, esse tipo de objeto é referido por departamento.

Campo Tipo Descrição
id int 64 Identificador único do grupo de acesso (obrigatório).
name int Nome do grupo de acesso (obrigatório).

user_groups

Relaciona os usuários as grupos de acesso.

Campo Tipo Descrição
user_id int 64 Identificador do usuário (obrigatório).
group_id int Identificador do grupo de acesso (obrigatório).

actions

Objeto que representa os scripts de ação.

Campo Tipo Descrição
group_id int 64 Identificador único do script de ação no banco de dados (obrigatório).
name string Nome descritivo da ação (obrigatório).
action string Nome do arquivo do script de ação (obrigatório).
parameters string Parâmetros do script de ação (obrigatório).
run_at int Pode assumir 3 valores. Caso seja 0, o script é executado no equipamento que o usuário utilizou para a identificação. Caso seja 1, o script é executado em todos os equipamentos conectados. Caso seja 2, o script é executado no servidor de identificação (obrigatório).

areas

Representa as áreas cujo acesso se deseja controlar.

Campo Tipo Descrição
group_id int 64 Identificador único da área (obrigatório).
name string Nome descritivo da área (obrigatório).

portals

Representa os portais. Um portal liga duas áreas e tem uma única direção.

Campo Tipo Descrição
id int 64 Identificador único do portal (obrigatório).
name string Nome descritivo do portal (obrigatório).
area_from_id int 64 Identificador da área de origem (obrigatório).
area_to_id int 64 Identificador da área de destino (obrigatório).

portal_actions

Relaciona portais e ações.

Campo Tipo Descrição
portal_id int 64 Identificador do portal (obrigatório).
action_id int 64 Identificador do ação (obrigatório).

access_rules

Representa as regras de acesso. A avaliação das regras de acesso acontece na seguinte ordem:

Dada uma tentativa de acesso, todas as regras de bloqueio são avaliadas antes das regras de liberação. Caso uma ou mais regras de bloqueio tenham seus critérios atendidos, suas ações serão executadas. Apenas caso nenhuma das regras de bloqueio tenham seus critérios atendidos, as regras de liberação são avaliadas e suas ações são executadas caso seus critérios sejam atendidos.

Campo Tipo Descrição
id int 64 Identificador da regra de acesso (obrigatório).
name string Nome descritivo da regra de acesso (obrigatório).
type int Tipo da regra de acesso: caso valha 0, é uma regra de bloqueio, e caso valha 1, é uma regra de permissão (obrigatório).
priority int Campo reservado (obrigatório).

portal_access_rules

Relaciona portais e regras de acesso.

Campo Tipo Descrição
portal_id int 64 Identificador da regra de acesso (obrigatório).
access_rule_id int 64 Identificador da regra de acesso (obrigatório).

group_access_rules

Relaciona grupos e regras de acesso.

Campo Tipo Descrição
group_id int 64 Identificador do grupo (obrigatório).
access_rule_id int 64 Identificador da regra de acesso (obrigatório).

time_zones

Conjunto de intervalos que representa o critério de horário de uma regra de acesso.

Campo Tipo Descrição
id int 64 Identificador do horário (obrigatório).
name string Nome descritivo do horário (obrigatório).

time_spans

Um dos intervalos de um horário, o qual representa o critério de horário de uma regra de acesso.

Campo Tipo Descrição
id int 64 Identificador do intervalo (obrigatório).
name string Nome descritivo do intervalo (obrigatório).
time_zone_id int 64 Horário ao qual esse intervalo pertence (obrigatório).
start int Horário de início do intervalo. É armazenado em segundos desde às 0 horas do dia. Exemplo: Uma hora da manhã será 3600, já que 16060 = 3600. Duas horas da manhã será 7200, já que 26060 = 7200 (obrigatório).
end int Horário de término do intervalo. É armazenado em segundos desde às 0 horas do dia (obrigatório).
sun int Indica se o intervalo está ativo para os domingos (obrigatório).
mon int Indica se o intervalo está ativo para as segundas-feiras (obrigatório).
tue int Indica se o intervalo está ativo para as terças-feiras (obrigatório).
wed int Indica se o intervalo está ativo para as quartas-feiras (obrigatório).
thu int Indica se o intervalo está ativo para as quintas-feiras (obrigatório).
fri int Indica se o intervalo está ativo para as sextas-feiras (obrigatório).
sat int Indica se o intervalo está ativo para os sábados (obrigatório).
hol1 int Indica se o intervalo está ativo para os feriados do tipo 1 (obrigatório).
hol2 int Indica se o intervalo está ativo para os feriados do tipo 2 (obrigatório).
hol3 int Indica se o intervalo está ativo para os feriados do tipo 3 (obrigatório).

contingency_cards

Cadastra uma lista de cartões que estará disponível em modo contingência para acesso aos equipamentos.

Campo Tipo Descrição
id int Identificador único do cartão, auto-incremental (obrigatório).
value int 64 Número do cartão liberado no modo de contingência (obrigatório).

contingency_card_access_rules

Vincula a regra de acesso que será válida para os cartões que estiverem cadastrados em contingency_cards.

Campo Tipo Descrição
access_rule_id int 64 Corresponde ao id da regra de acesso que será utilizada em modo de contingência, por padrão é: 1 (Regra de acesso sempre liberado). (obrigatório).

holidays

Essa tabela contém os feriados, assim como indica a qual tipo eles pertencem.

Campo Tipo Descrição
id int Identificador do feriado (obrigatório).
name string Nome descritivo do feriado (obrigatório).
start int A data e hora que o feriado começa em formato UNIX timestamp (obrigatório).
end int A data e hora que o feriado termina em formato UNIX timestamp (obrigatório).
hol1 int Se o feriado pertence ao grupo 1. O valor é 0 ou 1 (obrigatório).
hol2 int Se o feriado pertence ao grupo 2. O valor é 0 ou 1 (obrigatório).
hol3 int Se o feriado pertence ao grupo 3. O valor é 0 ou 1 (obrigatório).
repeats int Se o feriado deve repetir anualmente. O valor é 0 ou 1 (obrigatório).

alarm_zone_time_zones

Relaciona zonas de alarme e horários.

Campo Tipo Descrição
alarm_zone_id int 64 Identificador da zona de alarme (obrigatório).
time_zone_id int 64 Identificador do horário (obrigatório).

access_rule_time_zones

Relaciona regras de acesso e horários.

Campo Tipo Descrição
access_rule_id int 64 Identificador da regra de acesso (obrigatório).
time_zone_id int 64 Identificador do horário (obrigatório).

access_logs

Contém os logs de acesso do equipamento.

Campo Tipo Descrição
id int 64 Identificador do log de acesso (obrigatório).
time int Horário da ocorrência em Unix Timestamp.
event int Tipo do evento, pode ser:
  1. Equipamento inválido
  2. Parâmetros de regra de identificação inválidos
  3. Não identificado
  4. Identificação pendente
  5. Timeout na identificação
  6. Acesso negado
  7. Acesso autorizado
  8. Acesso pendente(usado quando o acesso depende de mais de uma pessoa)
  9. Usuário não é administrador (usado quando um usuário tenta acessar o menu mas não é administrador)
  10. Acesso não identificado (quando o portal é aberto através da API e o motivo não é informado)
  11. Acesso através de botoeira
  12. Acesso através da interface WEB
  13. Desistência de entrada (somente utilizado pela catraca)
device_id int 64 Identificador do equipamento onde o evento de acesso ocorreu.
identifier_id int Identificador do módulo de identificação que registrou o evento no equipamento.
user_id int Identificador do usuário envolvido na ocorrência.
portal_id int Identificador do portal envolvido na ocorrência.
identification_rule_id int Identificador da regra de identificação envolvida na ocorrência.
card_value int 64 Numero do cartão utilizado durante a identificação.
log_type_id int 64 Identificador únido do tipo de log, aplicável somente para o iDFlex Attendance (solução para marcação de ponto disponível apenas para exportação).

access_log_access_rules

Regras de acesso de um log de acesso. O par access_log_id e access_rule_id é único, ou seja, não pode haver nessa mais de um elemento com o mesmo par dessas propriedades.

Campo Tipo Descrição
access_log_id int 64 Identificador do log de acesso (obrigatório).
access_rule_id int 64 Identificador da regra de acesso (obrigatório).

alarm_logs

Contém os logs de alarmes do equipamento.

Campo Tipo Descrição
id int 64 Identificador do log de alarme (obrigatório).
event int Tipo do evento, pode ser:
  1. Alarm ativado
  2. Alarm Desativado
cause int Causa do evento, pode ser:
  1. Zona de alarme 1
  2. Zona de alarme 2
  3. Zona de alarme 3
  4. Zona de alarme 4
  5. Zona de alarme 5
  6. Porta aberta
  7. Arrombamento
  8. Dedo de pânico
  9. Tamper
user_id int 64 Identificador do usuário envolvido na ocorrência.
time int Horário da ocorrência em Unix Timestamp.
access_log_id int Identificador do registro de log de acesso envolvido na ocorrência.
door_id int Identificador da porta envolvida na ocorrência.

devices

Representa os equipamentos cadastrados neste equipamento. Usado somente na comunicação via rede entre equipamentos.

Campo Tipo Descrição
id int 64 Identificador do equipamento (obrigatório).
name string Nome descritivo do equipamento (obrigatório).
ip string Endereço do equipamento. Exemplo: 192.168.0.129 ou exemplo.controlid.com.br (obrigatório).
public_key string Chave criptográfica pública do equipamento, usada para a autenticação entre equipamentos (obrigatório).

user_access_rules

Vincula um usuário a uma regra de acesso.

O par user_id e access_rule_id é único, ou seja, não pode haver mais de um objeto nesta tabela com mesmos valores nesses campos ao mesmo tempo.

Campo Tipo Descrição
user_id int Identificador único do usuário (obrigatório).
access_rule_id int Identificador único da regra de acesso (obrigatório).

area_access_rules

Vincula uma área a uma regra de acesso.

O par area_id e access_rule_id é único, ou seja, não pode haver mais de um objeto nesta tabela com mesmos valores nesses campos ao mesmo tempo.

Campo Tipo Descrição
area_id int Identificador único da área (obrigatório).
access_rule_id int Identificador único da regra de acesso (obrigatório).

catra_infos

Permite consultar informações da catraca (aplicável apenas para catracas iDBlock).

Campo Tipo Descrição
id int Identificador da catraca.
left_turns int 64 Corresponde ao número de revoluções a esquerda.
right_turns int 64 Corresponde ao número de revoluções a direita.
entrance_turns int 64 Corresponde ao número de revoluções de entrada.
exit_turns int 64 Corresponde ao número de revoluções de saída.

log_types

Permite consultar os tipo de log.

Campo Tipo Descrição
id int Identificador do tipo de log (obrigatório).
name string Nome do tipo de log (obrigatório).

sec_boxs

Configura o modulo de acionamento externo (MAE/Security Box) usado no iDFlex, iDAccess Pro e iDAccess Nano.

Campo Tipo Descrição
id int 64 id da SecBox. Esse valor sempre será 65793.
version int Corresponde a versão da SecBox.
name string Corresponde ao nome da SecBox.
enabled bool Indica se a SecBox está habilitada ou não.
relay_timeout int Esse campo representa o tempo de abertura do relê da SecBox em (ms).
door_sensor_enabled bool Esse campo representa se o sensor de porta está habilitado ou não.
door_sensor_idle bool Esse campo representa se o sensor de porta está NO = 1 ou NC = 0.
auto_close_enabled int Inteiro (0 ou 1) indicando se o relê deverá fechar quando o sensor de porta abrir.