> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://ajuda.themembers.com.br/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Como utilizar a documentação API da TheMembers

### A API da TheMembers recebeu uma otimização importante.

Seja bem-vindo(a) à versão 1.0 da API do TheMembers!

Esta API foi projetada com foco nas necessidades dos nossos clientes, oferecendo uma forma simples, consistente e escalável de integração com a plataforma. 
Por meio dela, é possível gerenciar recursos essenciais como alunos, assinaturas, cursos e produtos. Nosso objetivo é facilitar a automação de processos e a integração com sistemas externos. 
Com esta versão, você poderá criar, atualizar e consultar dados de forma eficiente, utilizando ferramentas como n8n, scripts personalizados ou qualquer outra solução compatível com APIs REST.
A API segue padrões modernos de desenvolvimento, com endpoints organizados, respostas padronizadas e suporte à evolução contínua. 
Novos recursos e endpoints serão disponibilizados gradualmente, sempre mantendo a compatibilidade e a estabilidade das integrações existentes.
Recomendamos a leitura completa da documentação para entender os fluxos disponíveis, padrões de autenticação, versionamento e boas práticas de uso.

Para a utilização da mesma, recomendamos **__fortemente__** que, todo o passo a passo da configuração seja realizado juntamente com um profissional da área, técnico ou especializado em configurações deste tipo. 

### 🗃️ Para acessar toda a documentação de API, clique no link abaixo: 
https://documentation.themembers.dev.br/api-reference

# Autenticação

Para utilizar a nova versão da API, é necessário gerar um API Token por meio da dashboard da plataforma.

Acesse o dashboard em: https://dashboard.themembers.com.br 
No menu lateral, navegue até Plataforma → Configurações → Tokens.
Nesta seção, você encontrará dois tipos de tokens:
* Token Legado: utilizado pela API antiga
* API Token v1: utilizado por esta nova versão da API
Você pode gerar e revogar tokens conforme necessário.
Após criar um token, utilize-o como `Bearer Token` nas requisições da sua aplicação para autenticação.

![](https://storage.crisp.chat/users/helpdesk/website/-/d/d/8/4/dd84fe263ed8d000/image_slh52q.png =971xauto)

Para facilitar a identificação do seu token, coloque o nome que vá remeter à configuração que será utilizada, como o gateway de pagamento externo, o nome do CRM, etc.


![](https://storage.crisp.chat/users/helpdesk/website/-/d/d/8/4/dd84fe263ed8d000/image_1mwvojs.png =826xauto)

###### IMPORTANTE: Ao criar o código token, ele será exibido APENAS UMA VEZ! Quando fechar a janela, não dará para consultar qual é o código mais. Recomendamos que salve em um bloco de notas.
### 
![](https://storage.crisp.chat/users/helpdesk/website/-/d/d/8/4/dd84fe263ed8d000/image_42j3le.png =824xauto)


# Rate Limit

Nossa API implementa mecanismos de rate limiting para garantir a estabilidade e o bom funcionamento da plataforma.
Atualmente, é permitido realizar até 300 requisições por minuto. Caso esse limite seja excedido, será retornada uma exceção do tipo **RateLimitException**, com status code `429` (Too Many Requests).
Ao receber essa exceção, a resposta incluirá o campo **retry_after**, que informa o tempo (em segundos) que você deve aguardar antes de realizar uma nova requisição sem que o limite seja novamente atingido.
Caso necessite de um limite maior de requisições, entre em contato com nosso suporte para avaliação.

### API Alunos: 
https://documentation.themembers.dev.br/api-reference/reference/students

### API Inscrições - Assinaturas:
https://documentation.themembers.dev.br/api-reference/reference/subscriptions

### API Produtos: 
https://documentation.themembers.dev.br/api-reference/reference/products

### API Cursos: 
https://documentation.themembers.dev.br/api-reference/reference/courses

### API Anterior:
https://documentation.themembers.dev.br/
**A API anterior continuará em vigor mas recomendamos fortemente a migração para a nova versão.**