API

Seja bem-vindo(a) à documentação da API da iugu.

Apresentação

Nós criamos nossa API seguindo a técnica REST. Dessa forma, nossas URLs são amigáveis e previsíveis. Todas as nossas APIs respondem em JSON.

Todas as nossas chamadas são feitas, na versão mais atual da API, na URL https://www.agimpe.com.br/api/v1

Autenticação

A autenticação na Agimpe API é feita através da utilização de um API Token. Você pode gerenciar seus tokens nas configurações de sua conta.

Há duas maneiras de se autenticar, sendo a primeira, e mais recomendada, utilizando HTTP Basic Auth. Coloque seu API Token como sendo o username da autenticação básica sem necessidade de nenhum password (senha). A outra maneira é enviar o API Token num parâmetro de nome api_token.

Cada usuário tem seu próprio Token, além da conta. Caso mande o token do usuário, deve também ser enviado o account_id para que a iugu possa identificar para qual conta vai essa chamada. (Recomendamos que o api token de conta seja utilizado)

Os tokens de conta podem ser TEST ou LIVE, sendo que todas as chamadas em que tokens TEST são utilizados irão criar objetos de teste.

Todas as chamadas devem ser feitas via HTTPS e devem conter a autenticação.

Erros

A Agimpe API utiliza os próprios Códigos de Status HTTP para indicar sucesso ou falha da chamada. Em geral os códigos iniciados com 2 indicam sucesso, os iniciados com 4 indicam erro (Ex: Falta de parâmetro obrigatório) e iniciados com 5 indicam erro interno nos servidores da Agimpe.

Versionamento

Nós liberamos novas versões da API toda vez que efetuamos mudanças que não são retrocompatíveis, porém mantemos as antigas versões da API funcionando.

Nossas chamadas de API partem da URL https://www.agimpe.com.br/api/v1 sendo que esse v1 é justamente a versão da API.