Visão geral

Este manual refere-se à integração direta com os dispositivos das famílias A040, A050, A060 e A060T, contendo as principais funcionalidades para utilização do equipamento, sem a necessidade da utilização do SDK.

Cartão Usuário

Para poder realizar o registro é necessário que seja realizado da seguinte forma:
Registrar Cartão
Método POST http://deviceIP:8090/face/icCardRegist
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
personId ID da pessoa STRING Y
  • Referência para a pessoa designada.
  • É necessário que o personID já esteja registrado.
Exemplo retorno:
{
   "msg": "O modo de registro do cartão IC está ativado. Você pode buscar o ID do cartão IC com base no ID da pessoa.",
   "result": 1,
   "success": true
}
Para poder realizar a pesquisa é necessário que seja realizado da seguinte forma:
Pesquisar Cartão
Método GET http://deviceIP:8090/findICRecords
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
personId ID da pessoa STRING Y
  • Procurar o cartão de reconhecimento para a pessoa designada
  • Entre com o valor -1 para retornar todos os cartões
length Número Máximo de Página Int Y
  • Entre com o valor -1 para que todos os registros estejam em apenas uma página
  • Se não entrar com o dado -1, entre com valor acima de 0
index Numeração da Página STRING Y
  • Iniciar do 0
startTime Tempo de início de Log Date Y
  • Se não for procurar pelo tempo, entre com o valor 0
  • Se for procurar pelo tempo, entre com o formato 2017-07-15 12:05:00
endTime Tempo final de Log Date Y
Exemplo retorno:

Usuário

Para poder realizar o registro é necessário que seja realizado da seguinte forma:
Registrar Pessoa
Método POST http://DeviceIP:8090/person/create
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
person Informação da pessoa Json Y
  • Exemplo Json:
    {
       "id": "12345",
       "idcardNum": "4108221999908221428",
       "name": "Lucas Faria"
    }
  • Id e IdcardNum podem ter seu conteúdo vazio desta maneira:
    {
       "id": "",
       "idcardNum": "",
       "name": "Lucas Faria"
    }
  • Para um id que será passado, é necessário que os mesmos estejam em inglês e é diferenciado entre maiúsculas e minúsculas
Exemplo Retorno:
Para poder realizar a atualização do registro é necessário que seja realizado da seguinte forma:
Atualizar Pessoa
Método POST http://DeviceIP:8090/person/update
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
person Informação da pessoa Json Y
  • Exemplo Json:
    {
       "id": "12345",
       "idcardNum": "4108221999908221428",
       "name": "Lucas Faria"
    }
  • Id e IdcardNum podem ter seu conteúdo vazio desta maneira:
    {
       "id": "",
       "idcardNum": "",
       "name": "Lucas Faria"
    }
Exemplo Retorno:
Para poder realizar a exclusão do registro é necessário que seja realizado da seguinte forma:
Deletar Pessoa
Método POST http://DeviceIP:8090/person/delete
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
id ID da Pessoa STRING Y
  • Ao excluir mais de uma pessoa, use vírgulas entre o ID da pessoa
Exemplo Retorno:
Para poder encontrar o registro é necessário que seja realizado da seguinte forma:
Visualizar Pessoa
Método POST http://DeviceIP:8090/person/find
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
id ID da Pessoa STRING Y
  • Procura a pessoa de acordo com o ID especificado
  • Entre com o valor -1 para retornar todos os registros cadastrados no dispositivo
Exemplo Retorno:
Para poder atualizar a foto do registro é necessário que seja realizado da seguinte forma:
Atualizar Foto
Método POST http://DeviceIP:8090/face/update
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
personId ID da Pessoa STRING Y
  • Usado para fazer o link entre a foto e o usuário
faceId ID da Foto STRING Y
  • Atualiza a foto referente ao faceId
imgBase64 Base64 STRING Y
  • Sem Head, data: image/jpg; base64
isEasyWay Maneira solta ou rigorosa para registro das fotos BOOLEAN N
  • False: verifique rigorosamente a qualidade da foto
  • True: Verifique a qualidade da foto vagamente
Exemplo Retorno:

Configuração Dispositivo

Configurar Dispositivo
Método POST http://DeviceIP:8090/setConfig
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
config Setar configuração do dispositivo Json Y
  • O dispositivo tem a saída Wiegand 26 por padrão, podendo ser modificado para Wiegand 34
  • Slogan e o Display de introdução apenas no modo tela cheia
  • Se o parâmetro comModType for 100, o parâmetro comModContent também deve ser passado.
  • Todos os outros parâmetros são necessários
Exemplo Retorno:
Este comando possibilita que o dispositivo envie para um servidor dados do usuário reconhecido:
Callback
Método POST http://DeviceIP:8090/setIdentifyCallBack
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
callbackUrl Token URL STRING Y
  • Após o dispositivo realizar com sucesso o reconhecimento da pessoa, ele envia para o endereço POST o campo IP, Person ID, Time, DeviceKey, Type: Face/card0/1/2 e o caminho
  • Callback URL precisa esta no padrão de expressão regular: String Check "(HTTP ftp)://) ([azA-Z0- 9\.--] +\. [A-zAZ] {2,6} ([0-9] {1,3}\.\. 9] {1 [0- 9} {1, 3}. [0-9] {1,3}) ([0-9] {1,4} * (/ [a-zAZ0-9\ &% _/-] - *)?"
Exemplo Retorno:
Configurar Wi-Fi
Método POST http://DeviceIP:8090/setWifi
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
wifiMsg Setar as informações da configuração wireless Json Y
  • Aquisição de IP Automático:
  • IP Fixo:
Exemplo Retorno:
Configurar Network Cabeada
Método POST http://DeviceIP:8090/setNetInfo
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
isDHCPMod Seleção de modo DHCP Int Y
  • Configuração de customização de network configura o IP estático manualmente, o restante dos parâmetros devem ser não nulos
ip Endereço IP STRING
  • Aqui deve ser passado o campo IP que deve ser menor que 255
gateway Gateway STRING
subnetMask Máscara de Sub-rede STRING
DNS Server DNS STRING
Exemplo Retorno Configuração de modo DHCP (IP Automático):
Exemplo Retorno modo customizado (IP estático):
Configurar Network Cabeada
Método POST http://DeviceIP:8090/device/openDoorControl
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
Exemplo retorno da abertura de porta.
Configurar senha dispositivo
Método POST http://DeviceIP:8090/setPassWord
Parâmetros Descrição Tipo Transmissão Informação Adicional
oldPass Senha antiga do Dispositivo STRING Y
  • Para um dispositivo novo ou um após o reset, é necessário definir a senha inicial antes de chamar outras interfaces
  • A senha padrão do dispositivo é 12345678
  • Esta chamada de interface não requer um passe de entrada
  • A senha não pode ser nula ou vazia
newPass Nova senha do dispositivo STRING Y
Exemplo Retorno Configuração de modo DHCP (IP Automático):
Reiniciar Dispositivo
Método POST http://DeviceIP:8090/restartDevice
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y

Logs

Procura de Log
Método GET http://DeviceIP:8090/findRecords
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
personId Person ID STRING Y
  • Procura a pessoa de acordo com o ID especificado
  • Entre com o valor -1 para retornar todos os registros cadastrados no dispositivo
length Número máximo por página Int Y
  • Entre com valor -1 para mostrar todos logs em apenas uma página
  • Se não entrar com -1, por favor entre com um número acima de 0
index Número da Página Int Y
  • Inicia do 0
startTime Início do tempo de Log Date Y
  • Se não procurar por tempo, insira o valor 0
  • Se for procurar por um tempo, entre com o formato: 2017-07-15 12:05:00
endTime Fim do tempo de Log Date Y
Exemplo Retorno:
Deletar logs
Método POST http://DeviceIP:8090/newDeleteRecords
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
personId ID da Pessoa STRING Y
  • Deleta o log da pessoa designada
  • Entre com -1 para procurar os logs de reconhecimento de todas as pessoas
startTime Tempo de Inicio do Log Date Y
  • Delete todos os reconhecimentos de face de um período de tempo
  • Entre com 0 em startTIme para o registro mais antigo
  • Se procurar o log por tempo entre com o formato: 2017-07-15 12:05:00
endTime Fim do tempo de Log Date Y
model Tipo de conhecimento do Log Int Y
  • -1: Todos os tipos de reconhecimento
  • 0: Reconhecimento de Face
  • 1: Reconhecimento de Cartão & Face
  • 2: Comparação de ID do cartão & Face
  • 3: Reconhecimento de log Cartão
  • Qualquer outro valor é ilegal
Exemplo Retorno:

Configuração de Data/Hora

Após realizar esta configuração se faz necessário reiniciar o dispositivo
Configurar Zona de Tempo
Método POST http://DeviceIP:8090/device/setTimezone
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
timeZone STRING Y Fusos horários (TimeZone) permitidos:
  • Brazil/Acre - Horário de Brasília - 2 Horas
  • Brazil/DeNoronha - Horário de Brasília + 1 Hora
  • Brazil/East - Horário de Brasília
  • Brazil/West - Horário de Brasília - 1 Hora
locale STRING Y
Após realizar esta configuração se faz necessário reiniciar o dispositivo
Configurar data/hora
Método POST http://DeviceIP:8090/setTime
Parâmetros Descrição Tipo Transmissão Informação Adicional
pass Senha do Dispositivo STRING Y
timestamp STRING Y
  • formato Unix

Acesso com validação em servidor

Passo a passo para realizar a execução da abertura de porta com validação no servidor

  1. Desabilitar função de acionamento do relé no reconhecimento:

    • Enviar parâmetro “comModeType = 2” contido no comando “setConfig” (mais detalhes sobre o comando no tópico "Configurar Dispositivo")

    • Obs: O comando para desabilitar relé no momento do reconhecimento pode ser enviado somente uma vez, no startup do dispositivo A050.

  2. Abertura de porta:

    • O tempo de porta aberta deve ser parametrizado no comando setConfig através do parâmetro “delayTimeForCloseDoor”.

  3. Configurar callback

    • O dispositivo enviará o usuário reconhecido para o servidor

  4. Abrir porta

    • Utilizar o comando de abertura de porta