HomeGuides
API Reference

Parâmetros

Como obter os parâmetros de um relatório ?

Para obter todos os parâmetros do relatório anteriormente criado, basta realizar uma simples requisição com o método GET para nossa API no seguinte endpoint: https://api-v2.idwall.co/relatorios/{numero_do_relatorio}/parametros substituindo o parâmetro {numero_do_relatorio} pelo real número do relatório como mostra o exemplo abaixo.

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

Exemplo de sucesso

{
  "result": {
    "atualizado_em": "2018-11-19T19:39:43.565Z",
    "mensagem": "Válido.",
    "nome": "consultaPessoaDefault",
    "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "parametros": {
      "cpf": "30071998002",
      "data_de_nascimento": "30/07/1980",
      "nome": "Neville Longbottom"
    },
    "resultado": "VALID",
    "status": "CONCLUIDO"
  },
  "status_code": 200
}

🚧

O resultado retornado por esta rota varia conforme a matriz que é utilizada no momento da criação do relatório.

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
}

{
  "error": "Not Found",
  "message": "Protocolo não encontrado.",
  "status_code": 404
}

Updated over 5 years ago

What’s Next