API Reference

šŸŽ“ InscriƧƵes

Esta seção permite inscrever ou remover usuÔrios de grupos (também chamados de turmas ou conteúdos) dentro da plataforma. As inscrições definem quais usuÔrios têm acesso ao conteúdo dentro da plataforma.


šŸ“Œ Funcionalidades disponĆ­veis

MétodoEndpointDescrição
POST/enrollmentsInscreve um usuƔrio em um grupo
DELETE/enrollmentsExpira (remove) a inscrição de um usuÔrio em um grupo

šŸ” Autenticação e CabeƧalho

Todas as requisiƧƵes exigem um token de API vƔlido no cabeƧalho:

Authorization: Bearer {SEU_TOKEN_AQUI}
X-Requested-With: XMLHttpRequest
Content-Type: application/json

Esse token Ć© exclusivo por plataforma e deve ser gerado previamente pelo administrador.


šŸ“ Criar inscrição (POST /enrollments)

Parâmetros esperados:

CampoTipoObrigatórioDescrição
emailstringāœ… SimE-mail do usuĆ”rio jĆ” existente no sistema
group_idintegerāœ… SimID do grupo para inscrição
expires_atdatetimeāŒ OpcionalData de expiração da inscrição (ISO-8601)

Notificação por E-mail

Ao realizar uma inscrição com sucesso, a plataforma envia automaticamente um e-mail para o usuÔrio inscrito.

  • O conteĆŗdo do e-mail informa que ele foi adicionado a um grupo.
  • O envio Ć© automĆ”tico e nĆ£o exige nenhuma ação adicional na chamada.
  • O e-mail só serĆ” enviado se o usuĆ”rio possuir um endereƧo de e-mail vĆ”lido.

🧹 Expirar inscrição (DELETE /enrollments)

Parâmetros esperados:

CampoTipoObrigatórioDescrição
emailstringāœ… SimE-mail do usuĆ”rio
group_idintegerāœ… SimID do grupo do qual o usuĆ”rio serĆ” removido


🧠 Observações

  • O usuĆ”rio precisa estar previamente criado para ser inscrito.
  • A expiração da inscrição revoga imediatamente o acesso ao conteĆŗdo do grupo.
  • InscriƧƵes criadas via API tĆŖm o tipo "manual" no sistema.
  • Se o usuĆ”rio jĆ” estiver inscrito no grupo, apenas a data de expiração serĆ” atualizada.
  • Se nenhuma data de expiração for informada, a inscrição serĆ” considerada vitalĆ­cia.