> ## 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. # Página do curso > Módulos e aulas, com o que pode abrir agora e quando. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/classroom/courses/{publicId} 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: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth paths: /v1/clubs/{clubId}/classroom/courses/{publicId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/PublicId' get: tags: - classroom summary: A página do curso description: | Módulos e aulas publicadas, com o que o aluno pode abrir agora (`available`), quando vai poder (`available_at`) e o que já concluiu. Sem acesso, a estrutura vem igual, como vitrine, e toda aula vem indisponível. operationId: getClassroomCourse responses: '200': description: O curso content: application/json: schema: $ref: '#/components/schemas/ClassroomCourseResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '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 PublicId: name: publicId in: path required: true description: A chave curta da URL do classroom. schema: type: string minLength: 1 maxLength: 32 schemas: ClassroomCourseResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ClassroomCourse' ClassroomCourse: type: object required: - public_id - title - slug - has_access - show_modules - modules properties: public_id: type: string title: type: string slug: type: string description: type: string cover_url: type: string has_access: type: boolean access_until: type: string format: date-time description: Até quando o aluno tem este curso; ausente é vitalício. show_modules: type: boolean modules: type: array items: $ref: '#/components/schemas/ClassroomModule' 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 ClassroomModule: type: object required: - id - title - lessons properties: id: type: string format: uuid title: type: string lessons: type: array items: $ref: '#/components/schemas/ClassroomLessonItem' ClassroomLessonItem: type: object required: - public_id - title - type - available - completed properties: public_id: type: string title: type: string type: $ref: '#/components/schemas/LessonType' duration_seconds: type: integer thumbnail_url: type: string available: type: boolean description: Tem direito E a agenda já liberou. available_at: type: string format: date-time description: | Quando libera, se houver data. Ausente quando a agenda depende de algo que o aluno ainda não fez — aí quem responde é `release`. release: $ref: '#/components/schemas/ClassroomRelease' description: | A agenda desta aula, com o veredito de cada condição. Vem só quando a aula não está disponível e o aluno tem direito a ela: é a diferença entre uma agenda e um cadeado mudo. completed: type: boolean LessonType: type: string enum: - video - text - audio - file ClassroomRelease: type: object required: - kind - satisfied - label description: | A agenda como o aluno a vê: a mesma árvore, com o veredito de cada condição e a frase pronta. É o que permite à tela dizer o que falta quando não há data a mostrar. properties: kind: type: string satisfied: type: boolean at: type: string format: date-time label: description: A condição em português, já com título e data dentro. type: string children: type: array items: $ref: '#/components/schemas/ClassroomRelease' 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' NotFound: description: Recurso não encontrado 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 - [Cursos do aluno](/api-reference/classroom/courses-list.md) - [Listar cursos](/api-reference/content/courses-list.md) - [Criar curso](/api-reference/content/courses-create.md) - [Alterar curso](/api-reference/content/courses-update.md) - [Ler curso](/api-reference/content/courses-get.md)