As 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