Pular para o conteúdo principal
GET
Retorna o curso com módulos e aulas
Traz os módulos e as aulas que o membro pode ver, já filtrados pelas regras de liberação da turma. Módulos e aulas ocultos não aparecem. Uma aula que ainda não pode ser aberta vem com lock preenchido, explicando o motivo; veja Retorna uma aula. Mostre-a com o motivo em vez de escondê-la.
  • hero_image_url é a imagem de destaque do curso, com até 2400x1350. Quando ela não foi enviada, use image_url.
  • A image_url de cada módulo é a capa vertical, recortada em 300x420, ou nula.
  • A image_url de cada aula é a miniatura enviada para ela ou, sem miniatura, a capa do vídeo. Vem nula quando a aula não tem nenhuma das duas.
  • Cada módulo traz description, para mostrar abaixo do nome, e collapsed, quando o produtor pediu que ele comece recolhido na lista de aulas.
  • preferred_layout é list para mostrar as aulas numa lista única, ou grid para mostrar os módulos como cartões.
O parâmetro opcional classroom escolhe a turma quando o membro pode ver várias, como moderadores e assistentes. Sem ele, vale a turma do acesso do membro.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-Memberkit-Headless-Key
string
header
obrigatório

Chave headless da área de membros, em Configurações. É pública e vai em todas as requisições, inclusive nas que levam o token do membro.

Parâmetros de caminho

id
string
obrigatório

ID do curso.

Parâmetros de consulta

classroom
integer

ID da turma.

Resposta

Curso encontrado

id
integer
obrigatório
slug
string
obrigatório
name
string
obrigatório
description
string
obrigatório
preferred_layout
enum<string>
obrigatório

Layout do curso, em lista ou em cartões.

Opções disponíveis:
list,
grid
lessons_count
integer
obrigatório
image_url
string | null
obrigatório

Capa horizontal 432x216.

poster_url
string | null
obrigatório

Capa vertical 300x420, para categorias com capas verticais.

category
object | null
obrigatório
enrolled
boolean
obrigatório

Se o membro pode abrir o curso.

progress
integer
obrigatório
Intervalo obrigatório: 0 <= x <= 100
checkout_url
string | null
obrigatório

Página de vendas do curso, presente apenas quando enrolled é falso.

hero_image_url
string | null
obrigatório

URL da imagem de destaque do curso.

access_expires_at
string<date-time> | null
obrigatório

Quando termina o acesso do membro ao curso; nulo quando não expira.

classroom
object
obrigatório
sections
object[]
obrigatório