> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # O Início do aluno > Destaques, retomada, novidades e ritmo da semana, numa chamada só. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/classroom/home openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email - name: exports - name: certificates paths: /v1/clubs/{clubId}/classroom/home: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - classroom summary: A tela de Início do aluno description: | O que abre a área do aluno, numa chamada só: os destaques que o club escreveu, a aula em que ele parou, o que entrou de novo no que ele tem, e o ritmo da semana. É agregada de propósito. Cada bloco sozinho seria uma ida ao servidor, e a primeira tela do produto passaria a esperar cinco — a mais lenta mandando no relógio de todas. Bloco vazio vem vazio, nunca ausente: `resume` é nulo para quem ainda não começou nada, e as listas vêm `[]`. operationId: getClassroomHome responses: '200': description: O Início content: application/json: schema: $ref: '#/components/schemas/ClassroomHomeResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' security: - studentSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid schemas: ClassroomHomeResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ClassroomHome' ClassroomHome: description: | Tudo o que a tela de Início desenha. Bloco vazio vem vazio, nunca ausente. type: object required: - highlights - new_items - notices - latest_posts - rhythm properties: highlights: description: A faixa de abertura, na ordem definida pelo club. type: array items: $ref: '#/components/schemas/ClassroomHighlight' resume: $ref: '#/components/schemas/ClassroomResume' new_items: description: | O que entrou de novo nos cursos que este aluno já pode abrir, do mais recente para o mais antigo. type: array items: $ref: '#/components/schemas/ClassroomNewItem' notices: description: | Os posts FIXADOS dos espaços que este aluno alcança — o que o club quer que todo mundo leia. Vazio quando o club não fixou nada, e também quando não há comunidade. type: array items: $ref: '#/components/schemas/ClassroomHomePost' latest_posts: description: A conversa mais recente da comunidade. type: array items: $ref: '#/components/schemas/ClassroomHomePost' rhythm: $ref: '#/components/schemas/ClassroomRhythm' ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string ClassroomHighlight: description: | Um destaque como o aluno o recebe: sem ids internos, e com o destino já resolvido na chave que a URL do classroom usa. type: object required: - id - title properties: id: description: Só para o carrossel saber distinguir um slide do outro. type: string format: uuid kicker: type: string title: type: string body: type: string cta_label: type: string cover_url: type: string video_url: description: O vídeo de fundo, mudo e em laço. Ausente é capa parada. type: string course_public_id: type: string lesson_public_id: type: string live_public_id: type: string url: type: string ClassroomResume: description: | A aula em que a pessoa parou — a mexida mais recentemente que ainda não foi concluída. Ausente para quem ainda não começou nada. type: object required: - lesson_public_id - lesson_title - course_public_id - course_title - lesson_index - course_lessons - completed_lessons properties: lesson_public_id: type: string lesson_title: type: string course_public_id: type: string course_title: type: string thumbnail_url: type: string duration_seconds: type: integer last_position_seconds: description: Onde o vídeo parou, para a barrinha da miniatura. type: integer lesson_index: description: A posição da aula na fila do curso — o "5" de "Aula 5 de 8". type: integer course_lessons: type: integer completed_lessons: type: integer ClassroomNewItem: type: object required: - kind - title - course_public_id properties: kind: $ref: '#/components/schemas/ClassroomNewItemKind' title: type: string cover_url: type: string course_public_id: type: string lesson_public_id: description: Ausente quando o novo é o curso inteiro. type: string published_at: type: string format: date-time ClassroomHomePost: description: | Um post como a tela de Início o resume: sem mídia, sem reações e sem a conversa — quem quer isso abre o post. type: object required: - public_id - space_name - author_name - excerpt - created_at properties: public_id: type: string space_name: type: string author_name: type: string title: type: string excerpt: description: | O começo do post em texto corrido — o corpo é markdown, e a linha do Início não o desenha. type: string created_at: type: string format: date-time ClassroomRhythm: description: | O ritmo da semana: em que dias houve aula e qual a meta do aluno. A semana começa na SEGUNDA, como o calendário brasileiro. type: object required: - days - days_done - goal_days properties: days: description: Os sete dias da semana corrente, de segunda a domingo. type: array items: $ref: '#/components/schemas/ClassroomRhythmDay' days_done: type: integer goal_days: type: integer ClassroomNewItemKind: description: | O que é a novidade, para a etiqueta do card. `course`, `ebook` e `masterclass` são o curso inteiro estreando, no formato em que o club o publicou; `lesson` é aula nova em curso que o aluno já tinha. type: string enum: - course - ebook - masterclass - lesson x-enum-varnames: - ClassroomNewItemCourse - ClassroomNewItemEbook - ClassroomNewItemMasterclass - ClassroomNewItemLesson ClassroomRhythmDay: type: object required: - date - done properties: date: type: string format: date done: type: boolean responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: studentSession: type: http scheme: bearer description: | Token OPACO de sessão de aluno, emitido por `/v1/auth/sign-in` e verificado contra a nossa tabela — não é JWT e não se lê nada dele. A ida ao banco não é custo novo: toda requisição autenticada já resolve o dono da sessão. Em troca, encerrar uma sessão vale no mesmo instante, sem lista de bloqueio nem janela de tolerância. O classroom o guarda em cookie **host-only**: um cookie de domínio o mandaria para os subdomínios dos outros clubs. ```` ## Related topics - [Destaques do Início](/api-reference/classroom/banners-list.md) - [Mentorias](/essentials/mentorships.md) - [Sessão do aluno](/api-reference/auth/session.md) - [Cursos do aluno](/api-reference/classroom/courses-list.md) - [Turmas do aluno](/api-reference/classroom/cohorts-list.md)