idwall API

Introdução

Nossa API é RESTful e seguimos um padrão para todos os nossos endpoints para deixar a integração muito mais fácil para você.

👍

Endpoint base

https://api-v2.idwall.co

Nossas respostas tanto de sucesso quanto de erro são retornadas em formato JSON . Todas as requests que obtiverem sucesso serão retornadas com status code 200 no corpo da response junto com os objetos pertinentes a ela, já as requests que não obtiveram sucesso por algum motivo serão respondidas pela nossa API com o status code pertinente junto com informações adicionais que ajudarão na resolução do problema ocorrido.

🚧

Ambiente de teste

No cenário atual não possuímos uma sandbox para realização de testes do nosso sistema, ou seja, uma vez contratado você rodará em produção todo o tempo.

Token de autenticação

Para realizar consultas e criar relatórios via API, é necessário que você possua um token de autenticação , ele está disponível em sua dashboard na parte de integração da API .

❗️

Divulgação do token de autenticação.

Nunca divulgue ou mostre o seu token de autenticação para ninguém, pois ele é a sua senha de autenticação para que você possa utilizar os nossos serviços via API com segurança.

Exemplo de sucesso

Abaixo segue um exemplo de como a nossa API envia os dados caso a requisição seja realizada com sucesso, note que os parâmetros retornados são result (um objeto JSON que contém outros dados) e o status code .

Estes são os únicos parâmetros que a nossa API irá retornar caso a requisição não falhe, vale ressaltar que os dados transmitidos pela nossa API são frutos de consultas a diferentes tipos de bases de dados, os dados que são retornados podem variar muito de acordo com a matriz contratada, sendo assim o conteúdo do parâmetro result sofrerá alterações dependendo da matriz que esta sendo utilizada.

{
  "result": { },
  "status_code": 200,
}

Exemplos de erro

Os erros que a nossa API pode retornar são: 401 (falha na autenticação) este erro ocorre quando o token informado pelo cliente está incorreto ou não existe, 404 (não encontrado) este erro ocorre quando não foi possível localizar algo em nosso sistema com o parâmetro enviado pelo cliente, em ambos os casos vale verificar se o token informado ou o parâmetro enviado para busca estão corretos.

{
  "error": "Bad Request",
  "message": "child \"parametros\" fails because [\"dado_aleatorio\" is not allowed]",
  "validation": {
    "source": "payload",
    "keys": [
      "parametros.dado_aleatorio"
    ]
  },
  "status_code": 400
}

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

{
    "status_code": 404,
    "error": "Not Found",
    "message": "O protocolo requisitado não foi encontrado."
}

❗️

ERRO 500

Caso a nossa API retorne o erro 500 (internal server error) entre em contato com [[email protected]](mailto:[email protected])

Como utilizar nossas rotas ?

A maneira mais fácil e rápida de utilizar e entender como as nossas rotas funcionam é com a utilização da aplicação Postman , por meio desta aplicação fica muito fácil de compreender e gerenciar suas requests para uma determinada API.

📘

Sistemas operacionais compatíveis

O Postman é compatível com: Windows, distribuições Linux e com MacOS