A xAPI (Experience API) é um padrão de interface de especificação e dados de e-learning para coletar e compartilhar dados sobre a experiência de um aluno, dentro de um contexto de diversas atividades de aprendizado, incluindo online e offline.
Observação: a integração de xAPI está disponível somente no Plano Enterprise.
Índice
Declarações
Por meio da integração da xAPI com um sistema de terceiros, como LMS/LXP/LRS, a Udemy Business envia atividades correspondentes ao progresso do aluno e conclusão de um curso. Saiba mais sobre as declarações da xAPI que a Udemy Business envia.
Configuração da integração
Você pode configurar a Udemy Business para publicar declarações de xAPI em um LMS/LXP compatível pela interface de usuário de administração na Udemy Business, após a configuração relacionada ser feita no LMS/LXP primeiro. Veja abaixo as etapas a serem seguidas*
*As etapas 1 e 2 precisam ser feitas no LMS/LXP.
Etapa 1: registre a Udemy Business como uma aplicação de API no seu LMS/LXP e gere as credenciais de cliente.
Essa etapa é feita no LMS/LXP. Consulte o módulo de administração no seu LMS/LXP para configurar uma integração de xAPI. Você terá a opção de registrar uma aplicação de cliente e gerar um ID de cliente e um segredo do cliente para a aplicação de API.
Ao gerar as credenciais de cliente, verifique se o escopo de acesso está configurado como xapi:write. Observação: sem esse escopo, as declarações de xAPI enviadas da Udemy Business para o LMS/LXP vão falhar.
Converse com seu administrador do LMS/LXP para executar essa etapa.
Etapa 2: obtenha o endpoint do token do OAuth e o endpoint da declaração da xAPI no seu LMS/LXP
Essa etapa é feita no LMS/LXP. Sua instância do LMS/LXP deve ter um URL para o endpoint do token do OAuth e o endpoint da declaração da xAPI.
O endpoint do token do OAuth é o que a Udemy Business vai chamar para gerar tokens de autenticação, fornecendo o ID do cliente e o segredo do cliente gerados na etapa 1. Usando o token gerado, a Udemy Business vai POSTAR as declarações da xAPI no endpoint da declaração.
Exemplo:
URL do endpoint do token: https://udemy.lms.com/v3/oauth2/access-token
URL do endpoint da declaração da xAPI: https://udemy.lms.com/v3/xapi/statements
Observação: verifique se os URLs do endpoint são precisos. Verifique com seu LMS/LXP para obter os URLs do endpoint corretos para sua instância.
Etapa 3: configure a integração da xAPI na Udemy Business
-
Navegue até Gerenciar → Configurações → Integrações LMS/LXP
- Para parceiros de LMS/LXP que não estão incluídos, selecione Outros, informe a integração de LMS/LXP com um nome e selecione Salvar.
Observação: a página de configuração abaixo é a mesma para ativar chaves de API, a fim de acessar as APIs REST da Udemy Business (APIs de curso e geração de relatórios), e para configurar a xAPI. Mesmo que seu LMS/LXP esteja listado na lista suspensa, pode não haver suporte para configurar a integração de xAPI ainda. - Após selecionar seu LMS e clicar em Salvar, continue na tela abaixo. A primeira seção apresenta as chaves de API para acessar as APIs REST padrão da Udemy Business (API de curso e geração de relatório).
- Selecione Editar integração no canto superior direito e ajuste a configuração de xAPI para Ativado. A seção destacada abaixo corresponde às configurações de xAPI. Informe o URL do token do OAuth, o ID do cliente, o segredo do cliente e o URL da declaração da xAPI.
- Após inserir os detalhes, clique em Testar credenciais para verificar se a instância da Udemy Business é capaz de alcançar o URL do token. Clique em Salvar para armazenar suas configurações. Observação: esse teste verifica apenas se a Udemy Business é capaz de acessar o endpoint do token.
- Agora a integração de xAPI com seu LMS/LXP está finalizada e pronta para uso.
- As conclusões e o progresso do aluno fluirão para o LMS/LXP automaticamente em tempo quase real.
Configuração: caso especial
As etapas descritas acima devem ser seguidas APENAS quando seu LMS/LXP
- for compatível com eventos de progressão e conclusão e
- aceitar mbox (e-mail) como identificação da pessoa.
Se a configuração de xAPI for exibida na página de administração da Udemy Business ao lado do LMS selecionado, então quaisquer mudanças personalizadas (exemplo: seu LMS/LXP ser compatível apenas com eventos de conclusão ou exigir uma identificação da pessoa diferente de mbox - e-mail) já serão resolvidas pela implementação da Udemy Business. No entanto, se o seu LMS for exibido na lista, mas não tiver seção de configuração da xAPI, ou se você tiver um LMS personalizado que NÃO esteja na lista e tiver requisitos especiais em relação à identificação da pessoa e/ou verbos, entre em contato com o suporte da Udemy Business para obter esses requisitos.
Benefícios da xAPI
A Udemy Business já é compatível com APIs REST para fins de geração de relatórios (APIs de atividade do usuário, atividade do usuário no curso e progresso do usuário). Essas APIs incluem dados de transação granular (no nível da aula) e dados de resumo agregados (no nível do curso). Devido a esses diferentes níveis de agregação, essas APIs têm tempos de atraso que podem variar de 8 a 14 horas para que novos dados sejam disponibilizados. No entanto, as declarações de xAPI são em tempo quase real com atraso mínimo, mas fornecem menos informações.
Veja abaixo uma tabela que resume as principais diferenças entre as APIs REST padrão de geração de relatório e o fluxo de evento da xAPI.
Critério | xAPI | APIs REST de geração de relatório |
Latência | Fornece publicação em tempo quase real dos eventos de conclusão. Baixa latência. | Envolve um atraso de aproximadamente 8 horas antes que os eventos de conclusão sejam disponibilizados. |
Padrão | Segue um padrão da indústria para capturar e informar a experiência do aluno em um ambiente de aprendizado. |
Não segue um modelo de dados padrão, pode exigir personalizações para direcionar os dados a sistemas diferentes. |
Interoperabilidade | O modelo de dados padrão ajuda os sistemas a interagir uns com os outros facilmente e criar uma visão completa da experiência do aluno em diversos locais. | A interação entre vários sistemas exigiria conversões de dados e mapeamento entre os sistemas participantes. |
Consumo de recurso | A Udemy Business envia por PUSH os eventos ao sistema de terceiros, para que esses sistemas não tenham que buscar por PULL os dados na Udemy Business. Isso resulta em menos consumo de recursos e problemas de escalabilidade. | Exige que sistemas de terceiros obtenham dados por PULL da Udemy. Quando as solicitações e as cargas aumentam, isso pode levar a problemas de limitação de tempo. |
Preparado para o futuro | Padrão da indústria em rápido desenvolvimento. Permite expandir para uma ampla variedade de eventos de experiência do aluno (no futuro), por exemplo: acompanhamento granular de alunos em um conteúdo, interações, pesquisa, avaliação etc. | Atualmente limitado a eventos de conclusão e progresso no nível de aula e do curso, embora seja possível ampliar. No entanto, isso pode exigir relativamente mais trabalho, já que não há normas em vigor. |