Seja bem-vindo à referência da API da IDwall. Aqui você encontrará todas as nossas rotas de integração com exemplos de sucesso e de erros que podem vir a ocorrer.
1. Autenticação
Para realizar consultas e criar relatórios via API, é necessário que você possua um token de autenticação (esta informação é disponibilizada apenas para usuários com permissões “Escrita API”). Para encontrá-lo, basta fazer o seu login em nosso dashboard e clicar no link Integração da API , presente no menu lateral localizado no lado esquerdo da tela.
Na página, além de encontrar o código do seu token localizado na seção “Token da API”, você também poderá visualizar uma lista com todas as configurações que foram criadas para as suas validações. Ao clicar em “Visualizar configuração”, você encontrará o detalhamento do modelo de requisição com os parâmetros de input necessários de cada consulta.
Aviso
Caso você não possua uma conta, fale com seu Account Manager ou clique aqui e preencha o formulário. Após o envio a nossa equipe irá entrar contato o mais rápido possível para guiá-lo pelo caminho de criação da sua conta até a obtenção do token de autenticação.
2. API
A nossa APl é RESTful , onde todas as suas respostas são em formato JSON . Abaixo segue o nosso endpoint base.
Endpoint base
3. Ambiente de teste e de produção.
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.
4. Códigos HTTP de retorno da nossa API
Nesta seção serão apresentados os possíveis códigos HTTP que podem ser enviados pela nossa API. Caso você tenha curiosidade sobre os diferentes códigos HTTP que existem clique aqui.
| Código de resposta | Descrição |
|---|---|
| 200 | Sua requisição foi realizada e processada com sucesso. |
| 401 | Erro de autorização. Favor revisar se o parâmetro Authorization esta sendo passado pelo header da requisição junto com o seu token de autenticação. |
| 404 | Endpoint não encontrado, favor revisar a URL utilizada. Este erro também pode ocorrer caso algum parâmetro passado não esteja correto e assim a informação buscada não pode ser retornada. |
| 500 | Opa, algo de errado aconteceu! Tente sua requisição novamente. Caso o erro continue, entre em contato com [email protected] |
5. Possíveis status que um relatório pode assumir
| Status | Significado |
|---|---|
| PRE-PROCESSANDO | É o momento em que a imagem enviada esta passando pelo nosso OCR para que os dados sejam extraídos para serem utilizados na consulta. |
| PROCESSANDO | Aguardando as fontes da consulta terminarem a pesquisa para enviar a resposta. |
| EM ANÁLISE | Este status aparece quando uma das nossas fontes de consulta de dados está apresentando instabilidade. |
| CONCLUÍDO | Todas as fontes foram consultadas e todos os critérios de validação foram realizados com base nas informações colhidas da matriz utilizada |
PRÉ-PROCESSANDO
Este status só é visto pelos clientes que utilizam o nosso OCR.
DEU VALID!!!
Quando um relatório assumir o status concluído e o parâmetro resultado vier como VALID , significa que todos os critérios da matriz utilizada foram cumpridos
DEU INVALID. E AGORA ?
Quando um relatório assumir o status concluído e o parâmetro resultado vier como status INVALID será necessário realizar uma validação manual, pois um ou mais critérios da matriz utilizada não foram cumpridos. Existem duas formas de realizar esta ação:
1º acessar a sua dashboard e localizar o relatório e fazer as validações necessárias
2º Utilizar a nossa rota de validação manual passando os parâmetros necessários.