Aller au contenu

Matricula o usuário no curso

POST/api/courses/{courseId}/enroll

Auth
Jeton requis
Clé d’API:
courses:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Owner, admin, moderador ou membro da comunidade do `X-CommunityId`; só curso `published`.

**Idempotente** (mudança de contrato, 2026-10-10): matricular de novo, ou duas requisições ao mesmo tempo, responde **200 com a matrícula que já existe** (antes: 400), sem pontos `ENROLL_COURSE` extras. Só a requisição que cria a matrícula responde **201** e dá os pontos. Segue o espaço do curso: quem não pode abrir o espaço (privado ou de plano) recebe 403; curso de outra comunidade, 404. Quem tem matrícula `cancelled` começa de novo (200, `status: enrolled`, sem pontos). A corrida é resolvida pelo índice único (curso, perfil), não por leitura.

**Curso com produto.** Todo curso nasce com um produto `course` (1:1). Enquanto o produto é rascunho ou inativo, ou custa `0`, a matrícula é livre como sempre. Com o produto **publicado e preço maior que zero**, quem não comprou recebe **403** (`errors[0].param = courseId`, `data: { productId, price, currency }`), exceto a equipe (owner, admin, moderador, financeiro), quem tem assinatura ativa de um plano que **inclui** o produto e quem já estava matriculado quando o produto foi publicado (mantém o acesso). Acesso ao espaço sozinho não basta. Curso lotado (capacidade do produto): **409** (`data.soldOut = true`); reabrir uma matrícula `cancelled` também toma uma vaga. Para um curso gratuito publicado, o botão chama `POST /api/checkout` com o produto (matricula na hora).

Paramètres

NomEmplacementTypeDescription
courseIdobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.

Réponses

StatutDescription
200Já estava matriculado (ou recomeçou); devolve a matrícula existente.
201Matrícula criada.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/courses/<courseId>/enroll" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'