Skip to main content
A Studio API e a interface principal para usuarios finais da plataforma AWSales. Ela fornece tudo que sua aplicacao precisa para autenticar usuarios, gerenciar organizacoes e membros de equipe, lidar com assinaturas e cobrancas, e aplicar controle de acesso granular baseado em roles. Seja construindo uma integracao customizada ou incorporando o AWSales ao seu produto, a Studio API fornece uma interface RESTful consistente com autenticacao baseada em JWT, paginacao baseada em cursor e respostas de erro estruturadas.

​
URL Base

https://api.awsales.io/studio

​
Autenticacao

A Studio API utiliza JWT (JSON Web Tokens) para autenticacao. Apos o sign-in, o cliente recebe um accessToken e um refreshToken. Inclua o access token no header Authorization para todas as requisicoes autenticadas. 
curl https://api.awsales.io/studio/profile \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Ciclo de Vida do Token

TokenPropositoExpiracao
accessTokenAutentica requisicoes a APICurta duracao (retornado em expiresIn segundos)
refreshTokenObtem novos access tokens sem re-autenticacaoLonga duracao
Armazene o refreshToken de forma segura no lado do cliente. Use-o para obter um novo accessToken antes que o atual expire, para que os usuarios nao precisem fazer sign-in novamente.

​
Inicio Rapido

1

Faca sign-in para obter seu access token

Autentique com email e senha via POST /auth/sign-in. A resposta inclui um accessToken, refreshToken e expiresIn.
2

Obtenha seu perfil

Chame GET /profile com o access token para obter os detalhes do usuario e a lista de organizacoes as quais voce pertence.
3

Faca sua primeira chamada a API

Use o access token para chamar qualquer endpoint autenticado. Por exemplo, liste as memberships da sua organizacao com GET /organizations/{organizationId}/memberships.

​
Conceitos-Chave

  • Organizacoes sao a unidade de tenant. Usuarios pertencem a organizacoes via memberships.
  • Assinaturas vinculam organizacoes a planos com intervalos de cobranca.
  • Roles & Permissoes controlam o acesso usando o padrao resource:action.

​
Recursos

Autenticacao & Identidade

Sign up, sign in, OAuth, magic auth e redefinicao de senha.

OTP

Senhas de uso unico para verificacao de email, magic auth e redefinicao de senha.

Perfil

Perfil do usuario atual e troca de organizacao.

Memberships

Gestao e ciclo de vida de memberships da organizacao.

Convites

Convidar usuarios para organizacoes com atribuicao de role.

Roles

Gestao de roles RBAC com permissoes granulares.

Permissoes

Descoberta de permissoes do sistema e customizadas.

Planos & Assinaturas

Planos de assinatura, intervalos de cobranca e proximas faturas.

Cobranca

Faturas, metodos de pagamento, cupons e vouchers.