Cadastro Remoto Biometria Cartão

Realiza o cadastro de biometria ou cartão de proximidade remotamente. O método HTTP usado é o POST.

POST /remote_enroll.fcgi

Parâmetros

  • type (string) : Parâmetro que define a forma que será realizada o cadastro, sendo "card" ou "biometry" (obrigatório).
  • save (boolean) : O parâmetro "save" indica se o objeto (cartão ou biometria) deverá ser salvo no equipamento ou não. Caso save == false, o objeto será enviado ao gerenciador cadastrado, ou ao servidor (caso o equipamento esteja em modo enterprise). Padrão: false
  • user_id (int) : O parâmetro "user_id" recebe o id do usuário (Obrigatório quando save == true).
  • panic_finger (int) : O parâmetro "panic_finger" recebe se o dedo a ser cadastrado é um dedo de pânico, sendo os parâmetros 0 ou 1.
  • registration (string) : O parâmetro "registration" corresponde a matricula da pessoa que está realizando o cadastro de biometria.
  • msg (string) : O parâmetro "message" é a mensagem que será mostrada ao usuário durante o cadastramento. Quando vazia, a mensagem padrão é mostrada.
  • sync (bool) : O parâmetro "sync" corresponde se a forma de cadastro de biometria remoto será síncrono ou assíncrono, isto é quando o cadastro é feito de forma síncrona no request que é feito para o dispositivo, o retorno será o template com a estrutura acima, agora quando o cadastro é feito de forma assíncrona o equipamento envia um POST com a estrutura de parâmetros acima, dessa forma será necessário configurar um endpoint no seu servidor para receber essa requisição. Para realizar um cadastramento remoto de cartão ou biometria de forma assíncrona (sync == false), o monitor precisará estar previamente configurado no dispositivo e os correspondentes endpoints implementados no servidor. Caso ocorra um problema na execução o parâmetro sync retornará false junto com o parâmetro "error" que especifica qual o motivo do erro.

Resposta

  • Se o parâmetro "type" (acima) foi setado como "biometry" o retorno será "template: {"template" : , "user_id": , "finger_type": , "device_id" : }".
  • Se o parâmetro "type" (acima) foi setado como "card" o retorno será "card: {"value" : , "user_id": , "device_id" : }"

Exemplo de requisição

Inicia o cadastro remoto de biometria:

$.ajax({
    url: "/remote_enroll.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        type:"biometry",
        user_id:123,
        message:"Teste",
        save:true
    })
});

POST /cancel_remote_enroll.fcgi

Cancelar cadastro remoto em andamento: Este comando pode ser utilizado a qualquer momento que for necessário interromper o processo de cadastro descrito acima (remote_enroll). O método HTTP usado é o POST.

Parâmetros

  • Esta chamada não possui parâmetros.

Resposta

  • Esta chamada não possui retorno.

Exemplo de requisição

Cancela o cadastro remoto de biometria ou cartão em andamento:

$.ajax({
    url: "/cancel_remote_enroll.fcgi?session=" + session,
    type: 'POST', contentType: 'application/json'
});

POST /card_create.fcgi

Quando ocorrer o cadastro remoto de cartão no modo enterprise esse endpoint que será chamado. Como configurar o remote_enroll pode ser visto em Cadastro Remoto O método HTTP usado é o POST. O contentType é application/json.

Parâmetros

  • user_id (int 64) : Esse número representa o id do usuário.
  • card_value (int 64) : Número do cartão.
  • device_id (int 64) : Esse número representa o id do device.

Resposta

  • Esta chamada não possui retorno.

Exemplo de requisição

Exemplo de Mensagem:

{
    "user_id": 1,
    "card_value": 132456789,
    "device_id": 935107
}

POST /fingerprint_create.fcgi

Quando ocorrer o cadastro remoto de biometria no modo enterprise. O endpoint que será chamado é o fingerprint_create.fcgi que contém as imagens (fotos) do dedo capturadas pelo equipamento. Além disso como configurar o remote_enroll pode ser visto aqui Cadastro Remoto. O método HTTP usado é o POST. O contentType é application/json.

Parâmetros

  • user_id (int 64) : Esse número representa o id do usuário.
  • finger_type (int) : Onde 1 se for dedo de pânico, ou 0 caso não.
  • device_id (int 64) : Esse número representa o id do device que está ocorrendo o cadastro de cartão remoto.
  • fingerprints (array de objetos JSON) : Esse número representa o id do device.
    • image (string) : É o binário da imagem convertido para base64. Este binário é um bitmap de única cor onde cada byte representa um pixel. Portanto, um image deve conter width*height bytes.
    • width (int) : Largura da imagem.
    • height (int) : Altura da imagem.

Resposta

  • Esta chamada não possui retorno.

Exemplo de requisição

Exemplo de Mensagem:

{
    "user_id": 1,
    "finger_type": 0,
    "device_id": 935107,
    "fingerprints": [
        {
            "image": "Base64"
            "width": 300,
            "height": 200
        },
        {
            "image": "Base64"
            "width": 300,
            "height": 200
        },
        {
            "image": "Base64"
            "width": 300,
            "height": 200
        }
    ]
}

Nota: Caso o equipamento esteja configurado para extrair templates, o endpoint chamado será template_create.fcgi que contém os templates extraídos pelo equipamento.