Bem-vindo à API Pública da Plataforma Ensinio! Esta API permite que integradores criem e gerenciem usuários e inscrições diretamente em uma plataforma, utilizando um token de autenticação exclusivo da plataforma.
✅ Pré-requisitos
Antes de começar, certifique-se de ter:
-
A URL base da API pública:
https://sua-plataforma.ensinio.cloud/public/api/v1 -
Um token de API válido, gerado pelo administrador da plataforma.
Ele deve ser enviado em todas as requisições autenticadas.
🔐 Autenticação e Cabeçalhos
Todas as requisições devem conter os seguintes headers:
Authorization: Bearer {SEU_TOKEN_AQUI}
X-Requested-With: XMLHttpRequest
Content-Type: application/jsonExemplo:
POST /public/api/v1/users HTTP/1.1
Host: sua-plataforma.ensinio.cloud
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGci...
X-Requested-With: XMLHttpRequest
Content-Type: application/json📦 Recursos disponíveis
A API possui dois conjuntos principais de endpoints:
👤 Usuários
- Criar um novo usuário
- Deletar um usuário existente por e-mail
📚 Inscrições
- Criar uma inscrição de usuário em um grupo
- Expirar (remover) uma inscrição
Você pode consultar detalhes de cada rota no menu lateral.
📄 Formato das requisições
- Tipo de conteúdo:
application/json - Todas as respostas seguem o padrão de status HTTP
- Os erros retornam com mensagens no corpo em JSON
🚫 Limitações
- Apenas administradores da plataforma podem gerar tokens
- O token anterior é invalidado automaticamente ao regenerar