A API da Aira permite que você integre seu produto diretamente ao sistema de faturamento — enviando eventos de uso, gerenciando clientes e consultando faturas programaticamente.
Visão geral
A API segue o padrão REST com respostas em JSON. Todas as requisições são autenticadas via chave de API no headerX-API-KEY.
Base URL:
| Recurso | Endpoints | Descrição |
|---|---|---|
| Eventos | POST /v1/events/ingest | Envio de eventos de uso em lote |
| Clientes | POST, GET /v1/customers/ | Criar e consultar clientes |
| Recursos | POST, GET /v1/resources/ | Criar e consultar recursos |
| Faturas | GET /v1/invoices/ | Consultar faturas e baixar PDFs |
Comece por aqui
Autenticação
Configure sua chave de API e entenda o modelo de permissões.
Webhooks
Receba notificações em tempo real sobre mudanças de status de faturas.
Respostas de erro
Entenda o formato de erros e os códigos de status HTTP.