Introducci贸n
La API de EducUp (https://externalapi.educup.io/index.html) expone un grupo de funcionalidades que permiten a educadores y empresas interactuar con EducUp de manera m谩s robusta y sofisticada. Puedes hacer cosas como:
a) Obtener una lista de sus cursos.
b) Otorgar a un estudiante acceso premium a uno de sus cursos.
c) Obtener el listado de los cursos de la biblioteca de su empresa.
d) Obtener un token para un usuario (como una sesi贸n) para que no tenga que iniciar sesi贸n en EducUp y pueda interactuar con su contenido. (Esto es perfecto para los casos en los que integra sus cursos fuera del estudio, es decir, su panel de control, etc.)
e) Para las empresas, pueden crear un usuario (que luego puede acceder a la empresa cursos privados).
f) Crear grupos donde pueda agregar usuarios o alumnos.
Obteniendo un Token API
Para comenzar a utilizar la API de EducUp, el primer paso es obtener un token de clave API. Este token es necesario para autenticar solicitudes a la API de EducUp.
Pasos para obtener un token de clave API:
1. Reg铆strese o inicie sesi贸n: si a煤n no lo ha hecho, reg铆strese para obtener una cuenta en la plataforma de EducUp. Si ya tiene una cuenta, inicie sesi贸n con sus credenciales.
2. Navegue hasta Configuraci贸n de API: una vez que haya iniciado sesi贸n, navegue hasta la configuraci贸n de su cuenta o el panel de control. Busque una opci贸n relacionada con la configuraci贸n de API o herramientas de desarrollador.
3. Generar clave API: en la secci贸n de configuraci贸n de API, deber铆a encontrar una opci贸n para generar una clave API. Haga clic en esta opci贸n para crear un nuevo token de clave API.
4. Copie la clave API: despu茅s de generar la clave API, copie el token proporcionado. Este token se utilizar谩 para autenticar sus solicitudes en la API de EducUp. Gu谩rdelo de forma segura, ya que no se le volver谩 a proporcionar. Si se pierde, deber谩 crear una nueva clave API o regenerar la existente.
5. Autenticaci贸n: para autenticar solicitudes, incluya el valor del token en el encabezado "Autorizaci贸n" de sus solicitudes HTTP.
Documentaci贸n interactiva
Explore las funciones de EducUp API utilizando la documentaci贸n interactiva disponible en https://externalapi.educup.io/index.html. All铆 puede utilizar su token para acceder a las funcionalidades de la API.
Obteniendo cursos
Para recuperar cursos, realice una solicitud HTTP GET a la URL http://externalapi.educup.io/api/v1/courses incluyendo el token en el encabezado de Autorizaci贸n.
La respuesta contendr谩 informaci贸n estructurada de la siguiente manera. Vea el ejemplo a continuaci贸n:
El campo "data" contiene la lista de cursos con los campos proporcionados.
Obtenci贸n de token de usuario
Para obtener un token de usuario, que puede autenticar al usuario para diversos fines, como insertar una lecci贸n o un curso, realice una solicitud HTTP POST al punto final /API/v1/studio/obtain-user-token. En los par谩metros, debes pasar:
ID externo: este es un identificador que usaremos para identificar a su usuario. Ver谩s su identificador cuando accedas a la actividad del usuario a trav茅s de la API o desde Studio.
ID del curso: el ID del curso en EducUp para el cual desea el token.
Nombre y apellido: proporcione el nombre y apellido del usuario (opcional) en caso de que desee encontrarlos m谩s adelante al revisar esta informaci贸n.
CountryISOCode: El pa铆s del usuario. (opcional)
Por ejemplo, la URL aparecer铆a de la siguiente manera:
La respuesta contendr谩 un objeto JSON estructurado de la siguiente manera:
El token de acceso autentica al usuario para solicitudes de API. El token de actualizaci贸n puede obtener un nuevo token de acceso cuando caduque el actual. El campo de caducidad indica el per铆odo de validez del token de acceso en segundos.
Incrustar un curso
Puede utilizar el fragmento HTML proporcionado para insertar un curso para un usuario. Puede obtener esta URL en la secci贸n "Enlaces" del curso espec铆fico en Studio:
(https://studio.educup.io/courses/{course}/content/links).
Hay dos formas de insertar un curso:
1. Incrustar curso + autenticar usuarios
Este m茅todo es el m谩s recomendado ya que el usuario ingresar谩 autom谩ticamente a su curso sin necesidad de autenticarse. Por tanto, la experiencia ser谩 mucho m谩s fluida. Para lograr esto, primero solo necesita obtener un token para el usuario (consulte la secci贸n: Obtener token de usuario) y luego incrustar el token creado din谩micamente URL: https://app.educup.io/courses/{courseId}?token={userToken} (pasando el ID del curso correcto y el token del usuario). Al hacerlo, el usuario podr谩 acceder al curso, y toda su interacci贸n quedar谩 guardada para que pueda tenerla disponible.
2. Insertar curso sin autenticaci贸n
Con este m茅todo, puede insertar el curso sin autenticar autom谩ticamente al usuario. En cambio, una vez que complete el proceso de autenticaci贸n, ser谩 redirigido a la p谩gina de inicio de sesi贸n y luego a la p谩gina del curso.
Aqu铆 est谩 el HTML para incrustar sin autenticaci贸n de usuario:
En general, la idea es incrustar la URL: https://app.educup.io/courses/{courseId} (pasando el ID del curso correcto).
En este caso, si usted es un educador o una empresa y el usuario es uno de los estudiantes o empleados, le recomendamos encarecidamente agregar el usuario a su curso y asignarle acceso premium de antemano para garantizar que el usuario pueda acceder a todo el contenido del curso sin problemas.
Acceder a los datos de aprendizaje del usuario
Podr谩s acceder a la informaci贸n del usuario de 2 formas diferentes:
1. Desde el Estudio EducUp
Puede acceder a los datos del usuario, incluidos detalles, actividades, cursos inscritos y m谩s, desde EducUp Studio. (https://studio.educup.io/learners).
2. Desde la API de EducUp
Crear un usuario y asignar un producto
Para crear un usuario y asignar un producto o asignar directamente un producto a un usuario existente, realice una solicitud HTTP POST a http://externalapi.educup.io/api/v1/courses/add-premium-user
Si el usuario ya existe, solo se le asignar谩 el producto premium.
Esta gu铆a proporciona pasos esenciales para configurar y utilizar la API de EducUp. La documentaci贸n de la API proporciona m谩s detalles y funcionalidades avanzadas.