Integrações
Esta página descreve os endpoints da aba Integrações, da tela Cursos. Ela liga o curso ao curso equivalente em uma plataforma de ensino, para que as matrículas feitas no Pedagogo possam ser enviadas a essa plataforma. Na tela, a aba aparece somente para usuários com permissão de nível 2 ou superior e quando o cliente tem uma integração de ensino ativa.
Um curso tem no máximo um vínculo ativo por integração.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /comercial/courses/{course_uuid}/integrations | Lista os vínculos do curso com plataformas de ensino |
| POST | /comercial/courses/{course_uuid}/integrations | Vincula o curso a um curso de uma plataforma |
| DELETE | /comercial/courses/{course_uuid}/integrations/{id} | Desfaz o vínculo |
| GET | /comercial/courses/integrations | Lista as plataformas de ensino disponíveis para o cliente |
Consultar
GET /comercial/courses/{course_uuid}/integrations
Lista os vínculos do curso.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
search | Texto livre: descrição ou código do vínculo, ou nome da integração |
columnName e orderData | Ordenação: nome da coluna e asc ou desc |
Resposta: lista. Campos principais: id, course_id, integration_id, integration, code, description, user_create_name e user_update_name.
Vincular e desvincular
POST /comercial/courses/{course_uuid}/integrations
Vincula o curso a um curso da plataforma.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
integration_id | Sim | Número (id) | Plataforma de ensino. Veja GET /comercial/courses/integrations nesta página |
code | Sim | Texto, até 255 caracteres | Código do curso na plataforma |
description | Sim | Texto, até 255 caracteres | Descrição do vínculo |
Se o curso já tem vínculo ativo com a mesma plataforma, o envio de outro código é recusado com erro 422. A mensagem começa com "Este curso já está vinculado a um curso da" e pede que o vínculo seja desfeito antes. Para trocar o código, desvincule antes.
Depois de desvinculado, o curso pode ser vinculado de novo.
Resposta: 201 com o vínculo criado.
DELETE /comercial/courses/{course_uuid}/integrations/{id}
Desfaz o vínculo. O id é o da linha retornada pela listagem de vínculos do curso. Nas integrações de EAD Plataforma, o curso correspondente também é apagado na plataforma externa. Confira a descrição da integração antes de desvincular.
Resposta: 201, sem corpo.
Listas de apoio
GET /comercial/courses/integrations
Lista as plataformas de ensino disponíveis para o cliente. Use o id retornado no campo integration_id.