Para esta demonstração, será utilizada a linguagem Python, mas existem exemplos disponíveis em várias linguagens na documentação da API.

Após obter sua chave de acesso, o próximo passo será realizar sua primeira requisição à API, inserindo a chave no cabeçalho da requisição HTTP (<API-KEY>). Essa chave servirá para autenticar sua conta de usuário e, portanto, prosseguir com as requisições ao BioPass ID.

Para fazer uma requisição, além da chave de acesso, você precisará saber a URL da funcionalidade na qual deseja utilizar, e entender os parâmetros que devem ser passados para tal funcionalidade num arquivo de formato JSON. Para conhecer as operações e seus parâmetros, acesse a documentação da API.

Como exemplo, caso deseje cadastrar um usuário em sua aplicação, digite o código abaixo, conforme demonstrado na documentação:

import http.client
import json

conn = http.client.HTTPSConnection("hml-api.biopassid.com")
payload = json.dumps({
  "Person": {
    "CustomID": "1234",
    "Face": [
      {
        "Face-1": "/9j/4AAQSkZJRgABAQAAA..."
      }
    ]
  }
})
headers = {
  'Content-Type': 'application/json',
  'Ocp-Apim-Subscription-Key': '<API-KEY>'
}
conn.request("POST", "/multibiometrics/enroll", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))


Observe que o campo URL é preenchido conforme a requisição que desejamos fazer. Além disso, os dados passados são um objeto CustomID, que é uma string que será usada como identificador do usuário, e, portanto, deve ser única (uma recomendação seria o uso do documento de identificação do usuário para este cadastro), e uma Face, um array composto por uma string de base64 da imagem da face do usuário. Por fim, há também, em headers, o campo na qual a sua chave de acesso deve ser inserida.

Ao final, o bloco de código acima cria uma variável response, que recebe a resposta do pedido feito ao BioPass ID, que variará de acordo com cada método.

Caso seja retornado um erro, verifique se o texto em formato JSON foi escrito corretamente. Um exemplo de erro é o 400, Invalid JSON Format, que pode ser retornado quando alguma das variáveis não foi preenchida corretamente, ao faltar uma vírgula ou outra pontuação obrigatória na formatação do código, ou quando os requerimentos básicos dos dados a serem passados não são atendidos (por exemplo, o método de cadastro exige ao menos uma imagem da face ou uma imagem de digital).

Outro exemplo de erro é o erro 401 Unauthorized, que normalmente significa que a chave de acesso não foi inserida adequadamente ao código. Caso receba este erro, verifique sua chave de acesso e se sua inserção foi correta.

Caso seja recebido um código de resposta 200 (OK), isso significa que sua requisição foi solicitada e realizada com sucesso e, portanto, já pode seguir com as próximas requisições. Abaixo pode ser visto a resposta do sistema para a requisição feita no exemplo:

 

{
    "Person": {
        "ClientID": "1628692218558x176807293303153250",
        "CustomID": "1234",
        "BioPassID": "1648"
    }
}


Neste retorno, é possível verificar o código CustomID que foi utilizado para cadastro do template da imagem. É importante frisar que nós não guardamos a imagem que nos foi enviada, apenas o template que serve para identificar o usuário, descartando a imagem logo que este template seja gerado.