Manual API V1
Esta documentação detalha os endpoints disponíveis na API da acelera dados e disponibiliza um console interativo para que você consiga testar as requisições sem ser necessário escrever nenhuma linha de código. Além disso, através do console também é possível gerar automaticamente o código das requisições para diversas liguagens (PHP, Java, Ruby, entre muitas outras)
Caso você prefira utilizar o Postman para os testes, também disponibilizamos aqui a V1 com todos os exemplos para download.
Para testar os exemplos aqui descritos é necessário ter uma conta no aceleradados.com.br. Caso você ainda não tenha, basta criar uma clicando aqui. A criação da conta é simples e rápida, e não há custo algum.
Autenticação
A autenticação é feita através do fornecimento da sua API Key.
Ela deve ser transmitida em todas as requisições no header authorization: Bearer <>.
Caso a API Key seja inválida ou não seja informada, a aceleradados.com.br retornará HTTP 401.
Para obter sua API Key acesse o Menu API.
Atenção! Sua API Key carrega muitos privilégios, portanto certifique-se de mantê-la protegida.
Não informe ela em atendimentos e nem a exponha no front-end da sua aplicação.
Códigos HTTP das respostas
O Acelera Dados utiliza respostas HTTP convencionais para indicar sucesso ou falha nas requisições. Respostas com status 200 indicam sucesso, status 4xx indicam falhas decorrentes de erros nas informações enviadas, e status 500 indicam erros internos no servidor do Acelera Dados.
200 OK – Sua requisição foi bem sucedida.
400 Bad Request – Algum parâmetro obrigatório não foi enviado ou é inválido. Neste caso a própria resposta indicará qual é o problema.
401 Unauthorized – Não foi enviada API Key ou ela é inválida.
404 Not Found – O endpoint ou o objeto solicitado não existe.
500 Internal Server Error – Algo deu errado no servidor do Acelera Dados.
Todos os endpoints da API do Asaas recebem e responde em JSON.
Exemplo de resposta para HTTP 400
{ “errors”:[ { “code”:”invalid_value”, “description”:”O campo value deve ser informado” }, { “code”:”invalid_dueDate”, “description”:”A data de abertura não é uma data válida” } ] }