Respostas

Conteúdo

Sempre responderemos no formato JSON.

Você pode esperar o cabeçalho Content-Type com o valor application/json.

Limite

Cada aplicação possui o limite de 1.200 requisições por minuto. Caso você precise de mais requisições, entre em contato.

Algumas APIs podem ter limites mais restritivos. Consulte a documentação de cada uma para mais detalhes.

Status

Utilizaremos a especificação RFC7231.

Código	Significado	Observação
200	OK	A maioria das requisições retornará esse status.
201	Criado	O recurso solicitado foi criado.
400	Requisição inválida	Cheque se os parâmetros foram eviados corretamente.
401	Não autorizado	O token enviado é inválido.
403	Proibído	O token enviado é inválido ou você não tem permissão para executar essa ação.
404	Não encontrado	Cheque se o caminho está correto.
429	Muitas tentativas	Você atingiu o limite de requisições da API.
500	Erro interno	Não conseguimos processar a requisição nem identificar o erro.

Resposta

Sempre responderemos no formato JSON. Você pode esperar as seguintes chaves:

Chave	Valor	Descrição
success	boolean	Especifica se estamos retornando com sucesso (true) ou erro (false).
message	string	Uma mensagem explicando o resultado. Em alguns endpoints, iremos retornar mensagens amigáveis para o usuário final.
data	mixed	Essa chave é opcional e estará especificada em cada endpoint em que é usada.

Exemplo

const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.portalcredi.com.br/v1//',
  headers: {
    'Authorization': 'Bearer 999999-999999-999999-999999-999999-999999'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

copiar exemplo