Ranking do curso
GET/api/courses/{courseId}/leaderboard
- Auth
- Requiere token
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
F-06 fase 2. Os **10 primeiros** alunos por aulas concluídas no curso (empate: quem concluiu a última aula antes), com nome e avatar, e a posição de quem pede (`me`), mesmo fora do top 10. Sai de `lesson_progress`, não dos pontos. Só entram matrículas `enrolled` e `completed` e aulas vivas; quem saiu e a pré-visualização da equipe não entram. O top 10 fica em cache de **60 segundos** por curso; `me` é calculado na hora.
**Opt-in:** o ranking vem desligado; owner e admin ligam com `leaderboardEnabled: true` no curso. Desligado, **403**. Quem lê: a equipe (owner, admin, moderador, financeiro) e o aluno matriculado; os demais, 403.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
courseIdobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respuestas
| Código | Descripción |
|---|---|
200 | O ranking. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X GET "https://api.memberfy.net/api/courses/<courseId>/leaderboard" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"