Bem vindo a documentação da IDwall

Aqui você vai encontrar tudo que precisa para integrar o seu sistema com a nossa API

Vamos lá!

Listar pessoas

Como listar as pessoas anteriormente consultadas ?

O endpoint responsável pela listagem de matrizes é: https://api-v2.idwall.co/pessoas, agora basta realizar uma requisição com o método GET e você irá receber uma resposta com as pessoas que foram consultadas pela sua organização ordenadas pela última atualização de um relatório.

Segue um exemplo de requisição.

curl -X GET https://api-v2.idwall.co/pessoas 
-H "Content-Type: application/json"
-H 'Authorization:seu-token'

Exemplo de sucesso

{
  "result": {
    "busca": "",
    "itens": [
      {
        "cpf": "31071980687",
        "nome": "Harry Thiago Potter",
        "atualizado_em": "2018-11-20T16:12:38.120Z"
      },
      {
        "cpf": "38190719790",
        "nome": "Hermione Jean Granger",
        "atualizado_em": "2018-11-19T20:37:26.285Z"
      },
      {
        "cpf": "38519800301",
        "nome": "Ronald Bílius Weasley",
        "atualizado_em": "2018-11-19T19:39:43.565Z"
      }
    ],
    "paginacao": {
      "atual": 1,
      "linhas": 25,
      "total": "3"
    }
  },
  "status_code": 200
}

Exemplo de erro

{
  "error": "Unauthorized",
  "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
  "status_code": 401
}

Filtros

Você também pode realizar buscas com filtros por meio dos parâmetros passados pela urlencoded, abaixo segue exemplos de filtros que podem ser utilizados em nossa API.

Paginação e linhas

curl -G https://api-v2.idwall.co/pessoas
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "page=1&rows=25"

o número de linhas precisa ser sempre um múltiplo de 25

Filtro para buscar uma pessoa em específico

Pode-se realizar esta busca de duas formas, a primeira é pelo número do CPF onde ele é informado sem o uso de máscara ou pontos e a segunda forma é utilização do nome da pessoa como parâmetro.

curl -G https://api-v2.idwall.co/pessoas
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "cpf=cpf_da_pessoa_que_deseja_buscar"
curl -G https://api-v2.idwall.co/pessoas
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "nome=nome_da_pessoa_que_deseja_buscar"

Ordenação de resultados

É possível ordenar os resultados da sua requisição de forma crescente ou decrescente com base em um parâmetro presente na mesma, para isso basta informar o nome do campo que deseja utilizar como parâmetro de ordenação como mostra os exemplos abaixo.

curl -G https://api-v2.idwall.co/pessoas
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "sort=nome_do_parametro"
curl -G https://api-v2.idwall.co/pessoas
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "sort=-nome_do_parametro"

Combinação de filtros

É perfeitamente possível combinar os filtros para ter resultados diferentes com a sua necessidade, abaixo segue uma das possíveis combinações que podem ser utilizadas.

curl -G https://api-v2.idwall.co/pessoas
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "page=1&rows=25&sort=cpf&nome=nome_da_pessoa_que_deseja_buscar"