> For the complete documentation index, see [llms.txt](https://documentation.themembers.dev.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.themembers.dev.br/api-reference/readme.md).

# TheMembers - API v1

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.

### 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.

⸻

### Observação importante

{% hint style="warning" %}
Por motivos de segurança, o token gerado não poderá ser visualizado novamente após sua criação.
{% endhint %}

### 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.

#### Exemplo

```json
{
    "error": {
        "message": "Rate limit exceeded for API key 14",
        "type": "RateLimitException",
        "retry_after": 46
    }
}
```

Caso necessite de um limite maior de requisições, entre em contato com nosso suporte para avaliação.