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étodo | Endpoint | Descrição |
---|---|---|
POST | /enrollments | Inscreve um usuƔrio em um grupo |
DELETE | /enrollments | Expira (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
)
POST /enrollments
)Parâmetros esperados:
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
email | string | ā Sim | E-mail do usuĆ”rio jĆ” existente no sistema |
group_id | integer | ā Sim | ID do grupo para inscrição |
expires_at | datetime | ā Opcional | Data 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
)
DELETE /enrollments
)Parâmetros esperados:
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
email | string | ā Sim | E-mail do usuĆ”rio |
group_id | integer | ā Sim | ID 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.