Skip to main content
Esta documentação cobre tudo o que você precisa para entender e integrar com a AWSales — desde APIs REST e contratos de mensageria assíncrona até modelagem de domínio e jobs em background.

Guias

Comece com guias práticos e passo a passo que explicam os conceitos principais.

Autenticação

Cadastro, login, OAuth, magic links, gerenciamento de tokens e acesso multi-organização.

Início Rápido de Faturamento

Configure sua primeira assinatura, processe faturas e gerencie pagamentos de ponta a ponta.

Paginação

Navegue por grandes conjuntos de dados usando paginação baseada em cursor com filtros e ordenação.

Tratamento de Erros

Entenda os formatos de response de erro, sub-códigos 403 e implemente recuperação robusta.

Limites de Requisição

Headers de rate limit, backoff exponencial e estratégias para reduzir chamadas à API.

Referência da API

Studio API

API pública consumida pelo frontend do Studio. Cobre autenticação, assinaturas, faturas, métodos de pagamento e mais.

Admin API

API interna para operações de back-office — gerenciamento de usuários, configuração de organizações, planos, thresholds de faturamento e tokens.

Plataforma

Eventos

Contratos de mensageria assíncrona seguindo a especificação CloudEvents. Descreve todos os eventos publicados entre serviços.

Scheduler

Jobs em background e tarefas agendadas como despacho e processamento de liquidação de custos.

Modelagem de Dados

Schemas de entidades, relacionamentos e definições de campos para os domínios de IAM e Billing.

Domínio

Aprofundamento no domínio — IAM, ciclo de vida de faturamento, precificação, integração com Stripe e rastreamento de custos.