Skip to main content
A API Admin e a interface de gerenciamento interno para administradores da plataforma AWSales. Ela fornece endpoints abrangentes para gerenciamento de usuarios, ciclo de vida de organizacoes, operacoes de billing, controle de acesso e mais. Esta API foi projetada para ferramentas internas e dashboards administrativos — nao e exposta para clientes finais.

​
URL Base

Todas as requisicoes da API devem ser feitas para a seguinte URL base: 
https://api.awsales.io/admin

​
Autenticacao

Todos os endpoints (exceto OTP e health checks) requerem um token JWT valido obtido atraves do fluxo de sign-in sem senha. Inclua o token no header Authorization: 
curl https://api.awsales.io/admin/users \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Tokens de acesso expiram apos 1 hora. Use o refresh token para obter um novo token de acesso sem precisar de um novo fluxo OTP.

​
Inicio Rapido

1

Solicitar um OTP

Envie uma senha de uso unico para o email do admin usando o endpoint Enviar OTP.
2

Validar o OTP

Valide o codigo recebido usando o endpoint Validar OTP.
3

Fazer sign-in

Complete a autenticacao usando o endpoint Sign In para receber seu token de acesso.
4

Fazer chamadas a API

Use o token de acesso no header Authorization para todas as requisicoes subsequentes.

​
Recursos

Usuarios

Gerencie usuarios da plataforma, perfis e estado de autenticacao.

Organizacoes

CRUD completo para organizacoes tenant, incluindo configuracao de endereco e impostos.

Convites

Envie, reenvie e revogue convites de membros da organizacao.

Papeis e Permissoes

RBAC granular com gerenciamento de papeis e permissoes.

Planos

Ciclo de vida completo de planos: criar, atualizar, ativar/desativar, gerenciar intervalos.

Assinaturas

Visualize e gerencie assinaturas de organizacoes, vincule/desvincule cupons.

Faturas

Gerenciamento de faturas com acoes de pagamento e reemissao.

Limites de Faturamento

Configure limites de faturamento baseados em uso por organizacao.

Taxas

Defina e gerencie estruturas de taxas baseadas em uso.

Tokens

Definicoes de tipos de token para medicao de uso de IA.

Cupons

Cupons de desconto por percentual e valor fixo.

Vouchers

Vouchers de credito por organizacao.

Offboarding

Gerencie o ciclo de vida completo de offboarding: retencao, cancelamento e reativacao.

Health

Health checks da aplicacao e dependencias.

​
Tratamento de Erros

Todos os erros seguem uma estrutura JSON consistente. Veja a pagina de Tratamento de Erros para detalhes sobre codigos de status, formatos de erro e estrategias de retry.