.png){kind=logo}
Visão geral
-
A autenticação é obrigatória para consumir os recursos protegidos.
-
O token obtido deve ser enviado no cabeçalho
Authorization. -
Os relatórios podem ser consultados para descoberta, estrutura e download dos dados.
-
A API foi desenhada para facilitar integrações com sistemas externos e automações do cliente.
Métodos HTTP utilizados
|
Método |
Uso |
|---|---|
|
|
Recuperar informações e listar recursos |
|
|
Enviar requisições de autenticação e download |
Formatos de resposta
-
application/json -
text/json -
application/xml -
text/xml
Códigos de resposta mais comuns
|
Código HTTP |
Descrição |
|---|---|
|
|
Requisição concluída com sucesso |
|
|
Requisição inválida ou com parâmetros obrigatórios faltando |
|
|
Credenciais inválidas ou ausentes |
|
|
Requisição autenticada, mas sem autorização |
|
|
Recurso não encontrado |
|
|
Falha interna ao processar a requisição |
|
|
Resposta inválida do servidor upstream |
|
|
Serviço temporariamente indisponível |
Próximos passos
-
Acessar a seção de autenticação para obter o token.
-
Consultar a lista de relatórios disponíveis.
-
Consultar os dados do relatório desejado.