Matrícula na plataforma online/EAD

Envia matrículas online à plataforma online/EAD do cliente. Corresponde às ações Matricular no EAD da tela Alunos online: na linha, para uma matrícula, e no botão de ações em lote, para as matrículas selecionadas. A ação só aparece na tela quando o cliente tem uma integração de EAD ativa.

Para uma matrícula ser enviada, o curso precisa estar vinculado à plataforma online/EAD, na aba de integrações do curso. A matrícula manual e em lote não depende da configuração automática do cliente.

Endpoints

Método	Caminho	Descrição
POST	/comercial/online-students/ead/enroll	Envia uma ou mais matrículas à plataforma online/EAD
GET	/comercial/online-students/{training_student_uuid}/integrations	Lista os vínculos da matrícula com as plataformas online

Matrícula manual e em lote

POST /comercial/online-students/ead/enroll

Envia as matrículas informadas à plataforma online/EAD do cliente. Não há rota separada para uma matrícula só: a matrícula individual usa este mesmo endpoint, com um único uuid na lista.

Cada matrícula da lista é conferida antes do envio. Só entram no envio as que atendem às três condições:

• o curso está vinculado à plataforma online/EAD;
• a matrícula é avulsa, sem turma presencial;
• a matrícula ainda não está vinculada à plataforma.

As demais são contadas como ignoradas. Isso inclui matrículas de turma presencial, matrículas já vinculadas, cursos sem vínculo e uuid que não existem ou são de outro cliente.

As matrículas aceitas vão para a fila de envio. A resposta confirma quantas foram para a fila, e o envio ocorre em segundo plano.

Corpo

Campo	Obrigatório	Tipo	Descrição
training_student_uuids	Sim	lista de uuid	uuid das matrículas a enviar. Aceita pelo menos um item

Resposta: 200

Campo	Descrição
enrolled	Quantidade de matrículas enviadas para a fila
skipped	Quantidade de uuid informados que não foram enviados

Se o cliente não tem integração de EAD ativa, a resposta é 422, com {"message": "O cliente não tem uma integração de EAD ativa."}. Erros de validação do corpo seguem o formato de Convenções.

Exemplo

curl -X POST "https://api.pedagogo.app/comercial/online-students/ead/enroll" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "training_student_uuids": [
      "<uuid-da-matricula-1>",
      "<uuid-da-matricula-2>"
    ]
  }'

Vínculos da matrícula

GET /comercial/online-students/{training_student_uuid}/integrations

Lista os vínculos da matrícula com as plataformas online. Cada vínculo traz o código da matrícula na plataforma (code) e o nome da integração (integration_name). Só aparecem vínculos de integrações configuradas para o cliente.

Parâmetros de URL

Parâmetro	Descrição
course_integration_id	id do vínculo do curso com a integração
search	Busca pelo código da matrícula, pelo nome da integração ou pelo nome do curso
columnName e orderData	Coluna e sentido da ordenação
per_page e page	Paginação

Resposta: 200. Sem per_page, a resposta é uma lista simples. Com per_page, a resposta é paginada.

Na listagem de matrículas (GET /comercial/online-students), o campo ead_code traz o código da matrícula na plataforma quando ela já está vinculada.