Um guia rápido para sua integração
Queremos que sua integração seja ativada rapidamente, para que possamos disponibilizar novos mercados para nossos clientes mútuos.
Página de integrações da Udemy Business, exibida abaixo
Etapas de pré-requisito
- Inscrição de parceria enviada e aprovada
- A Udemy provisiona o ambiente sandbox para Udemy Business
- O administrador da Udemy convida outros usuários
Se algum desses itens estiver ausente, consulte o Guia de introdução para resolvê-los primeiro.
Casos de uso de integração do parceiro: se você quiser consultar os casos de uso de alto nível que essas etapas de integração viabilizam. Caso contrário, vamos avançar para o desenvolvimento.
Etapas de desenvolvimento
Nossa prática recomendada é mitigar o risco técnico, conectando a todas as APIs da Udemy primeiro, depois iniciando o desenvolvimento do software após confirmar o funcionamento de todos os endpoints.
- Conectar à API de cursos, retornar pelo menos 10 cursos
- Conectar à API de curso, retornar 1 curso
- Fazer login no site da Udemy Business e se inscrever em um curso, assistir a uma aula por pelo menos 1 minuto (você pode aumentar a velocidade de reprodução)
- Conectar à API de relatório (user-activity)
- Conectar à API de relatório (user-course-activity)
- Conectar à API de relatório (learning-activity-attempt)
- Fazer login no site da Udemy Business e criar uma trilha de aprendizado (documentação), abrir um curso e adicioná-lo à trilha de aprendizado criada
- Conectar à API de trilha de aprendizado, retornar a trilha de aprendizado que você criou
Configurações
Com a maioria das APIs funcionando, você pode passar às etapas de configuração.
- A configuração do Single Sign-On (SSO) é feita diretamente na sua página de configurações da Udemy Business. Você precisa ter credenciais de administrador para acessar essas configurações. Configure o SSO pronto para usar com um dos nossos diversos provedores. Ou crie uma conexão personalizada com SAML 2.0 (link para documentação de SSO).
- Confira o restante das configurações em [Udemy Business: Gerenciar: Configurações] e personalize como desejar.
Melhorias
Trilhas de aprendizado - Permite que os usuários criem uma grade curricular contendo diversos recursos de aprendizado, com início e fim para orientar os alunos.
- Fazer login no site da Udemy Business e criar uma trilha de aprendizado (documentação), abrir um curso e adicioná-lo à trilha de aprendizado criada
- Conectar à API de trilha de aprendizado; retornar a trilha de aprendizado que você criou
- Conectar à API de relatório (learning-path-activity)
Relatórios em tempo real via Webhook
- Configurar a xAPI, o webhook da Udemy para informar dados de progresso do aluno e eventos de conclusão (documentação). Você vai adicionar parâmetros na página de configurações do administrador da Udemy.
- Após a configuração, assista a uma aula na velocidade máxima de reprodução e confira se você recebeu os dados de progresso.
Dados de consulta ou pesquisa de cursos - Usando a API GraphQL da Udemy, permitimos consultas ao nosso catálogo de cursos, retornando apenas os dados que você precisa para aquele caso de uso específico. Além disso, também oferecemos uma API de pesquisa que usa suas entradas e filtra e retorna resultados relevantes de cursos.
- Obter as credenciais da API GraphQL
- Chamar a função GetAuthToken() do GraphQL
- Usar [authToken] para chamar a API de cursos
- Chamar a API CourseSearch
Observação: é preciso ter um login da Udemy Business para acessar a documentação do GraphQL. O URL aplicável apresenta o subdomínio da conta da Udemy da sua organização, seguido por .udemy.com/dev-portal/api-reference/.
Por exemplo:
https://{seu_subdominio}.udemy.com/dev-portal/api-reference/.
Desenvolvimento de software básico
Com todas as credenciais da Udemy funcionando, as APIs conectadas e as configurações adicionais ajustadas, o risco técnico terá sido eliminado. A maioria dos parceiros podem prosseguir com o planejamento ou ir direto ao desenvolvimento. Uma maneira de começar é obter uma lista de histórias de usuário ou casos de uso compatíveis e mapear as APIs necessárias para cada caso. Boa sorte com o desenvolvimento do software!
Controle de erros, exceções e práticas recomendadas
Fortaleça seu software incorporando controle de erros, exceções e casos extremos. Para lidar com erros inesperados de TI, temos diversas recomendações para o controle de erros.
Práticas recomendadas de API da Udemy Business
- Registrar as respostas de erro retornadas pelas APIs
- Adicionar a lógica de nova tentativa às chamadas da API
- Lidar com limites de taxa usando práticas recomendadas de page_size
- Implementar outras práticas recomendadas contidas no documento
Para mais suporte, feedback ou após concluir sua nova integração, entre em contato com partnersupport@udemy.com. Estamos ansiosos para abrir novos mercados juntos com nossa nova funcionalidade mútua.