Introdução à API

Confira uma breve introdução das APIs da iugu.

A iugu oferece uma interface de programação web no modelo REST, permitindo interação eficiente com seu sistema. Com essa API, você pode executar comandos, verificar configurações e sincronizar dados com seus próprios sistemas.

A comunicação é feita através do endereço base https://api.iugu.com, utilizando sempre o protocolo seguro https://. As versões da API são organizadas em diretórios específicos, sufixados ao endereço base (por exemplo, https://api.iugu.com/v1.


Postman Collection

Além das referências em dev.iugu.com, disponibilizamos uma Collection do Postman:

Run In Postman

Atualizado em 28/06/24

Notas de atualização

  1. Revisão em todos os parâmetros
  2. Adição de novos endpoints:
    1. Cartão de Crédito — Zero Auth
    2. QR Code Estático

Autenticação

A autenticação na iugu é realizada por meio de uma chave de API, que permite ao sistema identificar a sua conta e conceder as permissões necessárias para a comunicação com a iugu em nome da conta associada. Saiba mais.


Produção e Teste

A distinção de um ambiente de produção ou teste será feita através do api_token que for utilizado no momento da requisição. Crie um api_token e utilize de acordo com com sua necessidade.


Tabela de Erros (em construção... 🚧)

Disponibilizamos também uma tabela dos principais erros e seus motivos para consulta neste link.


Paginação

Para APIs de listagem, são utilizados parâmetros de paginação. Saiba mais.


Atualizações

Sempre que uma nova feature ou atualização acontece, informamos os detalhes em nossa Página de Atualizações.


Obter suporte

Se precisar de ajuda técnica, entre em contato com o nosso Suporte Técnico.