Documentación y guías de soporte

Las API de Udemy Business ofrecen funcionalidades de integración mediante diferentes métodos, para que goces de una mayor flexibilidad a la hora de desarrollar tu software.  En este artículo, se incluyen algunos usos posibles para cada una de ellas, así como recomendaciones sobre cuál elegir.

• Consulta los casos de uso de integración de socios compatibles con Udemy

Índice

• Cursos y otros objetos de aprendizaje
• Informes
• Vías de aprendizaje
• Inicio de sesión único (SSO)
• Legacy Courses API
• Integración más recomendada

Cursos y otros objetos de aprendizaje

API de cursos de GraphQL - Protocolo: GraphQL

• La nueva generación y el siguiente paso en las API de cursos tradicionales. En GraphQL, te permitimos obtener solo los metadatos del curso que especifiques. Además, podemos enviar los cursos que se ajusten a los criterios que especifiques gracias al sistema de consultas de GraphQL. 

Nota: Para obtener más información sobre la tecnología general que utiliza GraphQL, visita la página de GraphQL.

API de objetos de aprendizaje de GraphQL - Protocolo: GraphQL

• Además de los cursos, Udemy ofrece diferentes formas de aprender.  Exponemos todos los objetos de aprendizaje mediante la API para integrarlos en tu sistema.  Esta API te permite obtener cursos, laboratorios o insignias.  Al igual que con otros servicios de GraphQL, puedes utilizar consultas para obtener solo los objetos y los campos que especifiques.

Documentación: Debes tener acceso a Udemy Business para obtener la documentación de GraphQL. Accede al portal del desarrollador a través de esta URL: https://{tu_subdominio}.udemy.com/dev-portal/api-reference/

Informes

API de informes - Protocolo: RESTful

• Esta API contiene todos los datos del usuario recopilados sobre el progreso, las finalizaciones y las acciones dentro del aprendizaje.  Si quieres, puedes obtener los datos de informes de todos los usuarios o especificar un conjunto de usuarios. Debido al volumen de los datos, hay un retraso en las acciones de los usuarios que se recopilan y se incluyen en los informes.

Documentación: Documentación de API de Udemy Business - API RESTful

xAPI - Protocolo: xAPI

• Generación de informes en tiempo real que se proporciona a través de un webhook y se recopila siguiendo los estándares de tecnología de la educación de xAPI.  Udemy permite enviarte los datos sobre informes y el progreso en tiempo real conforme vayan ocurriendo.  Los datos que se incluyen en estos eventos en tiempo real tienen menos alcance que los datos de la API RESTful de informes.

Documentación: Documentación de xAPI de Udemy Business

Vías de aprendizaje

API de vía de aprendizaje - Protocolo: RESTful 

• Udemy permite a los estudiantes y los administradores del aprendizaje y el desarrollo crear vías de aprendizaje, colecciones de cursos y cualquier tipo de objeto de aprendizaje (o incluso enlaces externos). Utilizamos la API para exponer estas vías de aprendizaje y devolver todas las vías y los elementos que contienen.

Documentación: Documentación de API de Udemy Business - API RESTful

Inicio de sesión único (SSO)

Udemy Business puede conectarse con cualquier servicio de inicio de sesión único basado en SAML 2.0, lo que incluye a la mayoría de los proveedores de SSO. Además, existe la opción de crear integraciones de SSO personalizadas (siempre que sigan el estándar SAML 2.0).

Protocolo: SAML 2.0+

Documentación: Descripción general del SSO de Udemy Business y sus principales funciones

API de aprovisionamiento de usuarios de SCIM - El aprovisionamiento de System for Cross-domain Identity Management (sistema de gestión de identidades entre dominios) o SCIM te permite aprovisionar y desaprovisionar licencias de usuario. Este sistema permite que los equipos de TI o las integraciones personalizadas automaticen las funciones de gestión de licencias.

Protocolo: SCIM

Documentación: ​​Aprovisionamiento de System for Cross-domain Identity Management (SCIM)

Legacy Courses API 

API de cursos - Protocolo: RESTful 

• La API de cursos sigue normas tradicionales de la tecnología de la educación. Obtiene todos los metadatos de un único curso o de todos los cursos.

Nota: Esta es nuestra API de cursos heredada, por lo que no lanzaremos ninguna nueva funcionalidad para ella.  Todas las nuevas funciones se lanzarán en nuestra API de GraphQL, que además de cursos, también incluye otros objetos de aprendizaje.

Documentación: Documentación de API de Udemy Business - API RESTful

Integración más recomendada

Sabemos que cada cliente y socio de Udemy es diferente y que puede tener distintas necesidades. Para obtener una integración óptima, recomendamos incorporar las siguientes API:

1. Cursos y objetos de aprendizaje: utiliza la API de GraphQL para acceder a todos los objetos de aprendizaje.

2. Informes: utiliza la API de REST para abarcar todos los datos y compleméntala con xAPI para obtener datos en tiempo real.

3. SSO: utilízalo junto a SCIM para automatizar el aprovisionamiento y el desaprovisionamiento de usuarios.

4. Vías de aprendizaje: utiliza la API de vía de aprendizaje para permitir que los administradores del aprendizaje y el desarrollo y los encargados del programa creen vías de aprendizaje para los usuarios finales.

Udemy Business: El aprendizaje como motor de cambio

Accede al motor de aprendizaje de Udemy y ofrece contenido de desarrollo profesional en todas tus redes y ecosistemas. Para ello, puedes utilizar soluciones de conectividad escalables y las mejores aplicaciones, que atraen a las personas a tus plataformas y servicios en línea, y a los servicios de aprendizaje de Udemy. 

Udemy Business cuenta con miles de cursos que se crean y actualizan a la velocidad de los cambios del mercado (por ejemplo, el motor de aprendizaje).  Desde la codificación hasta las habilidades empresariales, el desarrollo personal y mucho más, Udemy ofrece cursos en línea demandados y de alta calidad que ayudan a las personas a alcanzar sus objetivos profesionales y a lograr los resultados empresariales esperados.

Gracias a la integración específica con Udemy Business, tus servicios ofrecerán a los usuarios las opciones Buscar y Descubrir en los cursos (y las vías de aprendizaje) de Udemy Business mejor valorados directamente desde tu plataforma. Esto permitirá iniciar un sitio de Udemy Business específico para sacar el mayor partido a la experiencia del curso completa. 

Índice:

Caso de uso 1: Integración de contenido

Beneficios clave

Caso de uso 2: Análisis y progreso del usuario

Beneficios clave

Proceso y etapas de la integración

Arquitectura de referencia de alto nivel

La integración con Udemy Business habilita los siguientes dos casos de uso principales: 

Caso de uso 1: Integración de contenido

Las integraciones de contenido amplían el acceso al aprendizaje en línea de Udemy Business (por ejemplo, cursos y vías de aprendizaje) y expanden la oferta de los principales servicios en línea.  Gracias a la integración de contenido de Udemy Business, los socios pueden ofrecer acceso de búsqueda y descubrimiento a los cursos y vías de aprendizaje en línea de Udemy Business (objetivos de aprendizaje estructurados) directamente en la web nativa o en las aplicaciones móviles nativas del socio.  Tus usuarios descubrirán e interactuarán con contenido (o vías de aprendizaje) de Udemy protegidos en un entorno familiar nativo.  El contenido integrado de Udemy Business beneficia a los usuarios (y a los socios) porque ofrece una interfaz de participación fluida con el sitio y los servicios del socio.  La integración de contenido se habilita por medio de servicios web modernos (por ejemplo, API) que se conectan a un potente motor de aprendizaje en línea.  Udemy ofrece asistencia a sus socios a través del diseño y alcance de un conector de integración de contenido, que incluye orientación sobre la creación, la prueba, la implementación y la gestión del ciclo de vida del conector como ayuda para la web nativa del socio o la experiencia de la aplicación (móvil). 

Beneficios clave:

• Accede al contenido de aprendizaje en línea más reciente para el desarrollo personal y profesional directamente desde tu web y desde tus aplicaciones móviles nativas.
• Incrementa la participación con contenido actualizado mediante sincronización automática fluida.
• Navega por el contenido con facilidad gracias a una experiencia de búsqueda y descubrimiento intruitiva.
• Controla el progreso del aprendizaje casi en tiempo real y mejora el desarrollo de la plantilla.
• Obtén un acceso fácil y seguro a través de los servicios de inicio de sesión único (SSO).
• Añade el aprendizaje a tu web nativa y aplicación móvil para disfrutar de una experiencia de aprendizaje sobre la marcha.

Caso de uso 2: Análisis y progreso del usuario

Conoce las necesidades de aprendizaje de tus usuarios integrando los datos de los estudiantes de Udemy Business. Al incorporar la participación del curso, el progreso y finalización de los usuarios a tus análisis, puedes personalizar y desarrollar de forma continua experiencias guiadas que respondan a las necesidades individuales y a conceptos clave (por ejemplo, vías de aprendizaje específicas).  Análisis de aprendizaje saca el máximo partido a un rico conjunto de datos de indicadores de participación del usuario, lo que permite a nuestros socios crear patrones de aprendizaje compuestos de sus usuarios en todos los conjuntos de datos únicos para mejorar de forma continua la experiencia de aprendizaje. 

Beneficios clave:

• Desarrolla el análisis de aprendizaje compuesto para obtener indicadores clave que revelan las necesidades de aprendizaje de tus usuarios.
• Utiliza información sobre el aprendizaje para adecuar el contenido de Udemy Business a tu audiencia.
• Amplía tu oferta de servicios aplicando inteligencia artificial para identificar las necesidades y los intereses únicos de tus usuarios.
• Mide y desarrolla de forma continua una experiencia de aprendizaje integral que promueva una experiencia de aprendizaje holística y un servicio enlazado.

Descubre el ecosistema de socios de Udemy, que incorpora servicios de Udemy Business y un potente motor de aprendizaje de Udemy. 

Proceso y etapas de la integración

De media, observamos que los socios destinan 4 semanas al diseño, al desarrollo y a la implementación de un conector basado en API para responder a los casos de uso descritos arriba.  Udemy Business designa un especialista en socios y un ingeniero de soluciones en el proyecto de desarrollo del conector para que guíen y aconsejen a los socios sobre las prácticas recomendadas para optimizar una integración con las API de Udemy. 

Arquitectura de referencia de alto nivel

A continuación, se muestran los componentes básicos de la integración.  La API de Udemy Business hace posible la sincronización de datos y el conector específico de cada socio la dirige.  Las funciones de búsqueda y descubrimiento de los cursos y las vías de aprendizaje de Udemy se habilitan por medio del conector directamente en la web nativa del socio y en las aplicaciones móviles. 

El inicio de sesión único opcional permite a los usuarios conectarse sin problemas a un sitio de Udemy Business directamente desde la plataforma de aprendizaje de los socios.

Una guía de inicio rápido para tu integración

Queremos que tu integración comience rápidamente para que todos podamos dar acceso a nuevos mercados a nuestros clientes comunes. 

A continuación se muestra la página Integraciones de Udemy Business

Pasos de los requisitos previos

• Solicitud de asociación enviada y aprobada
• Udemy ha proporcionado un entorno de sandbox para Udemy Business
• El administrador de Udemy ha invitado a usuarios adicionales

Si falta cualquiera de estos elementos, consulta la (Guía Primeros pasos) para conseguirlos en primer lugar.

Casos de integración de socios: Puedes revisar los casos de uso de alto nivel que pueden lograrse con estas instrucciones de integración.  Si no, vayamos al desarrollo.

Pasos de desarrollo

Recomendamos mitigar el riesgo técnico conectando primero con todas las API de Udemy para, a continuación, comenzar el desarrollo del software cuando se haya confirmado que todos los endpoints funcionan.

• Si te conectas a la API de cursos, obtienes al menos 10 cursos.
• Si te conectas a la API del curso, obtienes al menos 1 curso.
• Inicia sesión en tu página de Udemy Business, inscríbete en un curso y visualiza una clase durante al menos un minuto (puedes incrementar la velocidad de reproducción).
• Conéctate a la API de informes (actividad de usuarios).
• Conéctate a la API de informes (actividad de usuarios en cursos).
• Conéctate a la API de informes (intento de actividad de aprendizaje).
• Inicia sesión en la página de Udemy Business y crea una Vía de aprendizaje (documentación), abre un curso y añádelo a la vía de aprendizaje que acabas de crear.
• Si te contectas a la API de vía de aprendizaje, volverás a la vía de aprendizaje que creaste.

Configuraciones

Cuando funcionen la mayoría de las API, puedes pasar a los pasos de configuración.

• La configuración del inicio de sesión único (SSO) se hace directamente dentro de tu página Configuración de Udemy Business.  Necesitarás credenciales de administrador para acceder a esta configuración.  Configura nuevos SSO desde cero con uno de nuestros muchos proveedores.  O bien, crea una conexión personalizada con SAML 2.0. (enlace a la documentación sobre SSO).
• Revisa el resto de la configuración en [Udemy Business: Gestionar: Configuración] y personalízala como quieras.

Mejoras

Vías de aprendizaje: permite a los usuarios crear un currículum que incluye un gran variedad de recursos de aprendizaje con un punto de inicio y fin para guiar al estudiante.

• Inicia sesión en la página de Udemy Business y crea una Vía de aprendizaje (documentación), abre un curso y añádelo a la vía de aprendizaje que acabas de crear.
• Conéctate a la API de vía de aprendizaje y vuelve a la vía de aprendizaje que has creado.
• Conéctate a la API de informes (learning-path-activity).

Generación de informes en tiempo real a través de webhook

• Configurar xAPI, el webhook de Udemy para obtener datos de generación de informes sobre el progreso y la finalización de eventos del estudiante (documentación).  Añadirás parámetros a la página de configuración de administrador de Udemy.
• Una vez se haya completado la configuración, visualiza una clase corta a la velocidad de reproducción máxima y comprueba si recibes los datos de progreso.

Consultar o buscar datos del curso: con la API de GraphQL de Udemy, puedes enviar consultas al catálogo de cursos que te devolverán solamente los datos que necesites para un caso de uso específico.  También ofrecemos una API de búsqueda que toma tus indicaciones, aplica filtros y ofrece resultados de cursos relevantes.

• Obtener credenciales de API de GraphQL
• Llamar a la función de GraphQL GetAuthToken()
• Utilizar [authToken] para llamar a la API de cursos
• Llamar a la API de CourseSearch

Nota: Para acceder a la documentación de GraphQL, deberás iniciar sesión en Udemy Business. La URL correspondiente incluye el subdominio de la cuenta de Udemy de tu organización, seguido de .udemy.com/dev-portal/api-reference/. 

Por ejemplo:

https://{tu_subdominio}.udemy.com/dev-portal/api-reference/.

Desarrollo del software principal

Cuando funcionen todas las credenciales de Udemy, estén conectadas todas las API y se hayan realizado las configuraciones adicionales, se habrá eliminado el riesgo técnico.  A continuación, muchos socios pasarán a la planificación o directamente al desarrollo.  Una forma de comenzar es seleccionar una lista de historias de usuarios o casos de uso compatibles y determinar las API de Udemy necesarias para cada caso de uso.  A partir de aquí, mucha suerte a tu ingeniería de software. 

Solución de errores, excepciones y prácticas recomendadas

Refuerza el software incorporando gestión de errores, excepciones y casos extremos.  Para poder gestionar los problemas informáticos no esperados, tenemos varias recomendaciones de solución de errores. 

• Registra las respuestas a errores de API.
• Añade lógica de reintento a las llamadas de API.
• Gestiona los límites de frecuencia utilizando prácticas recomendadas de tamaño de página.
• Aplica otras prácticas recomendadas descritas en el documento.

Para obtener asistencia adicional y comentarios, o al finalizar la nueva integración, ponte en contacto con nosotros en partnersupport@udemy.com.  Esperamos abrir juntos nuevos mercados con nuestra nueva función conjunta.

Los socios de tecnología de Udemy Business utilizan las API de la plataforma para habilitar la sincronización automática del contenido de UB y de los datos sobre la actividad de los estudiantes en la plataforma asociada. Las integraciones solo están disponibles para clientes comunes. ¿Todo listo para crear una integración con Udemy Business? A continuación, encontrarás documentación que te ayudará a comenzar.

• Resumen de API disponibles
•  API web de Udemy Business: casos prácticos y prácticas recomendadas
• Casos de uso de la integración de los socios
• Pasos de integración para socios de tecnología

Con las API web de Udemy Business (REST/GraphQL/xAPI), conecta fácilmente tus herramientas de administrador, plataforma de LMS y paquetes de RR. HH. con el catálogo de cursos de Udemy (a través de metadatos) y los datos de participación de los estudiantes.

Potencia el aprendizaje en el lugar de trabajo mediante:

• Sincronización automática de datos de usuario entre Udemy Business y tu directorio de empleados (por ejemplo, Okta, Azure)
• Incorpora la búsqueda, el descubrimiento y la publicación de clases de cursos y cursos de Udemy Business a tus sistemas de RR. HH.
• Obtén análisis en tiempo real de la participación en los cursos de tu organización directamente desde las aplicaciones

Ten en cuenta que la guía a la que se hace referencia y se enlaza a continuación está publicada en el centro de asistencia de Udemy Business.

• Más información: API web de Udemy Business: casos prácticos y prácticas recomendadas