-
Resumo das APIs disponíveis
Ler artigoAs APIs da Udemy Business oferecem a funcionalidade de integração em diversos métodos diferentes, para oferecer a você mais flexibilidade no desenvolvimento do seu software. Este artigo descreve alguns dos possíveis usos para cada uma e as recomendações de qual escolher.
Índice
- Cursos e todos os objetos de aprendizado
- Geração de relatórios
- Trilhas de aprendizado
- Single Sign-On (SSO)
- API de cursos legada
- Melhor integração da classe recomendada
Cursos e todos os objetos de aprendizado
API de cursos GraphQL – Protocolo: GraphQL
- A próxima geração e a evolução da API tradicional de cursos. No GraphQL, para cada curso, permitimos que você obtenha apenas os metadados do curso que você especificar. Além disso, utilizando o sistema de consulta do GraphQL, permitimos o retorno de cursos que atendem aos seus critérios específicos.
Observação: para saber mais sobre a tecnologia geral por trás do GraphQL, acesse a página da organização GraphQL.
API de todos os objetos de aprendizado GraphQL – Protocolo: GraphQL
- A Udemy oferece diversas maneiras de estudar, além dos cursos. Podemos expor todos os objetos de aprendizado via API para integração no seu sistema. Essa API permite que você obtenha cursos, laboratórios ou insígnias. Assim como em outros serviços GraphQL, você pode usar consultas para obter apenas os objetos e campos que especificar.
Documentação: você deve ter acesso à Udemy Business para obter a documentação do GraphQL. Consulte o Portal do Desenvolvedor neste URL: https://{your_subdomain}.udemy.com/dev-portal/api-reference/
Geração de relatórios
API de geração de relatórios – Protocolo: RESTful
- Esta API contém todos os dados de usuário coletados sobre progresso, conclusões e ações no aprendizado. Você pode optar por obter todos os dados de relatórios do usuário ou especificar um conjunto de usuários. Devido à quantidade de dados, há um atraso para as ações dos usuários serem coletadas e informadas.
Documentação: documentação da API da Udemy Business – APIs RESTful
xAPI – Protocolo: xAPI
- Relatórios em tempo real, entregues via webhook, desenvolvidos de acordo com os padrões xAPI EdTech. A Udemy permite ver dados de relatório e progresso em tempo real. Os dados contidos nesses eventos em tempo real têm menos escopo quando comparados com a API de geração de relatórios RESTful.
Documentação: documentação de xAPI da Udemy Business
Trilhas de aprendizado
API de trilhas de aprendizado – Protocolo: RESTful
- A Udemy permite que alunos e administradores de A&D criem trilhas de aprendizado, uma coleção com vários cursos e qualquer outro tipo de objeto de aprendizado, e até mesmo links externos. Essas trilhas de aprendizado são expostas via API e retornam todas as trilhas e os itens contidos nelas.
Documentação: documentação da API da Udemy Business – APIs RESTful
Single Sign-On (SSO)
A Udemy Business é capaz de se conectar a todos os serviços de Single Sign-On SAML 2.0, o que inclui a maioria dos servidores de SSO. Além disso, integrações personalizadas de SSO estão disponíveis desde que sigam o padrão SAML 2.0.
Protocolo: SAML 2.0+
Documentação: visão geral do SSO da Udemy Business e os principais recursos
APIs de provisionamento de usuário SCIM – O provisionamento de System for Cross-domain Identity Management (SCIM) permite que você provisione e desprovisione licenças de usuário. Esse sistema permite que suas equipes de TI ou integrações personalizadas automatizem as funções de gerenciamento de licença.
Protocolo: SCIM
Documentação: provisionamento de System for Cross-domain Identity Management (SCIM)
API de cursos legada
API de cursos – Protocolo: RESTful
- A API de cursos segue as normas tradicionais de EdTech. Ela obtém todos os metadados de um único ou de todos os cursos.
Observação: essa é nossa API de cursos legada e não vamos lançar novas funcionalidades nessa API. Todos os novos recursos serão lançados nas nossas APIs GraphQL, que contêm os cursos e também todos os objetos de aprendizado.
Documentação: documentação da API da Udemy Business – APIs RESTful
Melhor integração da classe recomendada
Sabemos que cada cliente e parceiro da Udemy é diferente e tem necessidades variadas. Para ter a melhor integração da classe, recomendamos incorporar as seguintes APIs:
1. Cursos e objetos de aprendizado: utilize a API GraphQL para acessar todos os objetos de aprendizado
2. Geração de relatórios: use a API REST para ter o escopo completo de dados e complemente usando a xAPI para dados em tempo real
3. SSO: deve ser utilizado com a adição do SCIM para automatizar o provisionamento e desprovisionamento de usuários
4. Trilhas de aprendizado: utilize a API de trilhas de aprendizado para permitir que líderes de programa e administradores de A&D criem caminhos de aprendizado para o usuário final
-
Casos de uso de integração do parceiro
Ler artigoUdemy Business - Melhorando vidas por meio do aprendizado
Acesse o mecanismo de aprendizado da Udemy e ofereça conteúdo de desenvolvimento profissional nas suas redes e ecossistemas, com a escala de soluções de conectividade e aplicativos de melhor versão, que atraem as pessoas com seus serviços e plataformas online e os serviços de aprendizado da Udemy.
A Udemy Business conta com milhares de cursos criados e atualizados na mesma velocidade das mudanças do mercado (ou seja, o mecanismo de aprendizado). De programação a habilidades comerciais, desenvolvimento pessoal e muito mais, a Udemy conta com cursos online de alta qualidade e em alta demanda que ajudam as pessoas a alcançar suas metas profissionais e resultados comerciais.
Com uma integração intencional na Udemy Business, seus Serviços vão oferecer aos usuários pesquisa e descoberta de cursos conceituados da Udemy Business (e trilhas de aprendizado) nativamente pela sua Plataforma, com a possibilidade de acessar um site dedicado da Udemy Business para ter a experiência completa de curso.
Índice:Caso de uso 1: integração de conteúdo
Caso de uso 2: análise e progresso do usuário
Cronograma e marcos da integração
Arquitetura de referência de alto nível
Uma integração com a Udemy Business permite os dois casos de uso básicos a seguir:
Caso de uso 1: integração de conteúdo
As integrações de conteúdo ampliam o acesso ao aprendizado online da Udemy Business (como cursos e trilhas de aprendizado) e ampliam suas ofertas de serviços básicos online. Com a integração de conteúdo da Udemy Business, os Parceiros podem oferecer acesso pesquisável e detectável aos cursos online e trilhas de aprendizado da Udemy Business (metas de aprendizado estruturadas) diretamente nos aplicativos móveis/Web nativos do Parceiro. Seus usuários vão encontrar e interagir com conteúdo selecionado da Udemy (ou trilhas de aprendizado) em uma experiência nativa familiar. O conteúdo integrado da Udemy Business beneficia os usuários (e Parceiros) oferecendo uma interface de engajamento contínua com os sites e serviços do Parceiro. A integração de conteúdo é viabilizada por modernos serviços de Web (por exemplo, APIs) que são conectados a um avançado mecanismo de aprendizado online. A Udemy apoia os Parceiros com escopo e design do Conector de integração de conteúdo, incluindo orientações sobre como criar, testar, implantar e gerenciar o ciclo de vida do Conector para apoiar a experiência em aplicativo Web (ou móvel) nativo.
Principais benefícios:
- Acessar o conteúdo de aprendizado online mais recente para desenvolvimento pessoal e profissional diretamente pela Web ou pelos aplicativos móveis nativos
- Aumentar o engajamento com o conteúdo atual por meio de sincronização automática contínua
- Navegar pelo conteúdo facilmente com uma experiência intuitiva de pesquisa e descoberta
- Monitorar o progresso do aprendizado em tempo quase real e apoiar o desenvolvimento do funcionário
- Acesso fácil e seguro por meio de serviços de Single Sign-On (SSO)
- Levar o aprendizado para seu aplicativo móvel e móvel nativo para uma experiência de aprendizado em qualquer lugar
Caso de uso 2: análise e progresso do usuário
Veja insights sobre o aprendizado dos usuários com a integração dos dados de aluno da Udemy Business. Ao incorporar o engajamento no curso, o progresso e as conclusões do usuário nas suas análises, você pode personalizar e desenvolver continuamente experiências guiadas reconhecendo as necessidades individuais e principais conceitos (por exemplo, trilhas de aprendizado específicas). A análise de aprendizado utiliza um amplo conjunto de dados com indicadores de engajamento do usuário, permitindo que nossos Parceiros criem padrões de aprendizado compostos sobre seus usuários com conjuntos de dados exclusivos para melhorar continuamente a experiência de aprendizado do usuário.
Principais benefícios:
- Desenvolver análises de aprendizado compostas para descobrir os principais indicadores nas necessidades de aprendizado dos usuários
- Usar insights de aprendizado para personalizar o conteúdo da Udemy Business ao público-alvo
- Ampliar as ofertas de serviços com inteligência de máquina para identificar as necessidades e os interesses exclusivos dos usuários
- Medir continuamente e desenvolver uma experiência de aprendizado abrangente que promova uma experiência holística e um serviço integrado
Criado com os Serviços da Udemy Business e o avançado mecanismo de aprendizado da Udemy, conheça o ecossistema de Parceiros da Udemy
Cronograma e marcos da integração
Em média, os Parceiros dedicam quatro semanas para criação, desenvolvimento e implantação de um conector baseado em API para apoiar os casos de uso acima. A Udemy Business dedica um líder de parceiros e um engenheiro de soluções por meio do projeto de desenvolvimento do Conector para guiar e aconselhar os Parceiros sobre as práticas recomendadas para otimizar a integração com as APIs da Udemy.
Arquitetura de referência de alto nível
Os componentes básicos da integração estão descritos abaixo. A sincronização de dados é viabilizada pelas APIs da Udemy Business, e orquestrada pelo Conector criado pelo Parceiro. A pesquisa e a descoberta de cursos e trilhas de aprendizado da Udemy é viabilizada pelo Conector diretamente nos aplicativos móveis e Web nativos do Parceiro.
Com Single Sign-On opcional, os usuários continuam conectados a um site da Udemy Business diretamente pela plataforma de aprendizado do Parceiro.
-
Etapas de integração para parceiros de tecnologia
Ler artigoUm 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.
- 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.
-
Documentação e guias de apoio
Ler artigoOs parceiros de tecnologia da Udemy Business usam as APIs da plataforma para permitir a sincronização automática do acervo de conteúdo da UB e dos dados de atividade dos alunos na plataforma do parceiro. As integrações estão disponíveis apenas para clientes mútuos. Quer começar a criar uma integração com a Udemy Business? Encontre a documentação abaixo para começar.
-
Web APIs da Udemy Business: casos de uso e práticas recomendadas
Ler artigoCom as Web APIs da Udemy Business (REST/GraphQL/xAPI), conecte facilmente suas ferramentas de administrador, plataformas de LMS e conjuntos de RH ao catálogo de cursos da Udemy (via metadados) e dados de engajamento do aluno.
Viabilize o aprendizado no local de trabalho com:
- Sincronização automática de dados do usuário entre a Udemy Business e seu diretório de funcionários (por exemplo, Okta, Azure)
- Pesquisa, descoberta e lançamento integrados de cursos e aulas da Udemy Business nos seus sistemas de RH.
- Análise em tempo real de engajamento no curso para sua organização direto dos aplicativos
O guia indicado abaixo está publicado na Central de ajuda da Udemy Business.