Saltar al contenido principal

Cómo crear una API key o conectar un LMS con POK

El panel de Integraciones es donde conectas POK Proof of Knowledge con los sistemas que ya usas. Cada opción del panel genera una de estas dos cosas: una API key para llamar a la propia API de POK desde tus sistemas, o un registro LTI que pegas en un LMS para que pida credenciales por su cuenta. Elige una plataforma de la lista, como Moodle o Canvas, para una configuración guiada, o usa "Integración personalizada" para generar una API key o una URL LTI simple para cualquier otro sistema.

Abre el panel de Integraciones

Necesitas rol de administrador. "Integraciones" solo aparece en el menú de la barra superior para administradores; los operadores y lectores no tienen esta opción.

En la barra de navegación superior, haz clic en el nombre de tu organización y luego en "Integraciones".

Llegas a dos secciones: "Mis integraciones", con lo que ya conectaste, y "Listado de plataformas" debajo, con cada plataforma que puedes conectar. Una columna a la izquierda tiene una guía corta ("Guía de integración") y, bajo "Documentación de integración", enlaces a la guía de configuración de cada LMS de la lista.

Qué puedes conectar

El "Listado de plataformas" y el diálogo de "Nueva integración" que se abre desde "Mis integraciones" ofrecen las mismas plataformas:

  • Moodle (LMS): asocia tus actividades de Moodle a los diseños de tus certificados para emitirlos dentro de POK de forma automática.
  • Canvas (LMS): vincula tus cursos de Canvas con POK y automatiza la emisión de credenciales según el rendimiento o finalización de actividades formativas.
  • OPEN edX (LMS): conecta tus cursos de Open edX y automatiza la emisión de credenciales en POK según el progreso o finalización de tus alumnos.
  • Blackboard (LMS): conecta tus cursos de Blackboard con POK y automatiza la emisión de credenciales basadas en el progreso y logros de tus estudiantes.
  • D2L Brightspace (LMS): conecta tus cursos de Brightspace con POK y automatiza la generación de credenciales basadas en el progreso y logros de tus estudiantes.
  • Sana (LMS): conecta tus cursos de Sana con POK y emite credenciales automáticamente cuando los alumnos los completan. Sana se conecta por xAPI, no por LTI.

Si tu sistema no está en esta lista, abre "Nueva integración" en "Mis integraciones" y elige "Integración personalizada" ("URL LTI o API Key · cualquier sistema"). Genera una API key simple o una URL LTI simple que funciona con cualquier sistema capaz de llamar a una API o de registrar una herramienta LTI.

Cada LMS de la lista tiene su propia guía de configuración: Moodle, Canvas, Blackboard, D2L Brightspace, Sana, Open edX.

Crea una API key

  1. En "Mis integraciones", haz clic en "Nueva integración".
  2. Haz clic en "Integración personalizada".
  3. En el campo del nombre, escribe uno que te ayude a reconocerla después, por ejemplo el nombre del sistema que estás conectando.
  4. Selecciona "Integración por API Key" ("Generar API Key para conectar con llamadas directas a través de nuestra API desde sistemas externos").
  5. Haz clic en "Confirmar".
  6. Elige el permiso que tendrá la key: "Permiso Administrador" ("Podrá ejecutar acciones como emitir credenciales por api") o "Permiso Lector" ("Solo podrá realizar consultas de lectura").
  7. Haz clic en "Confirmar" de nuevo.

POK genera la key y la muestra en un diálogo: "Lo siguiente es tu Api Key, recuerda copiarla y mantenerla en un lugar seguro ya que no la podrás recuperar más tarde. Este es el único momento que la verás disponible." Una vez que cierras el diálogo, la key en texto plano desaparece para siempre, la tarjeta de esa integración en "Mis integraciones" solo la muestra enmascarada de ahí en adelante. Si la pierdes, elimina la integración y crea una nueva; no hay forma de recuperar el valor anterior.

El diálogo no te deja cerrarlo sin darte cuenta: marca la casilla que confirma que ya copiaste la key y la guardaste en un lugar seguro antes de que "Aceptar" quede habilitado.

OPEN edX es la única excepción a este flujo. Al hacer clic en "Conectar" en su tarjeta de plataforma, se saltan por completo los pasos de nombre y permiso: POK crea de inmediato una key llamada "OpenEdx" con permiso de administrador. Consulta la guía de integración con Open edX para saber qué hacer con ella del lado de Open edX.

Qué puede hacer una API key

Una API key funciona como la credencial de tu organización para un sistema informático: quien la tiene puede llamar a la API de POK como si fuera tu organización, por ejemplo para emitir credenciales de forma automática. Lo que puede hacer depende del permiso que le diste:

  • Permiso Administrador puede ejecutar acciones de escritura, incluida la emisión de credenciales por API.
  • Permiso Lector solo puede realizar consultas de lectura.

Para entender cómo una solicitud demuestra que tiene una key válida, consulta autenticación de la API. Para la lista completa de endpoints, empieza por la referencia de la API. Una vez que tienes una key con permiso de administrador, emitir una credencial por API y filtrarla por tags es el siguiente paso natural.

Registra una integración LTI personalizada

Para generar una URL LTI simple en lugar de una API key, sigue el mismo flujo de "Integración personalizada" y en el paso 4 elige "Integración por LTI" ("Generar URL de integración LTI para conectar a tu LMS de forma estandarizada") en lugar de "Integración por API Key". Un registro LTI no tiene paso de permisos.

POK muestra la URL apenas confirmas: "Copia y pega la siguiente URL en tu plataforma compatible con LTI. Asegúrate de guardarla para habilitar la conexión con POK y no perderla." A diferencia de una API key, esta URL no se muestra una sola vez: puedes volver a copiarla cuando quieras haciendo clic en "Copiar URL" en su tarjeta dentro de "Mis integraciones". Una integración personalizada como esta no guarda credenciales propias para actualizar, así que si cambian los datos de conexión, elimínala y crea una nueva.

Administra tus integraciones

Cada API key, registro LTI y conexión de Sana que creaste aparece como una tarjeta en "Mis integraciones". Una API key o una conexión de Sana siempre muestra un tilde de verificación; un registro LTI muestra el tilde cuando está activo, o un ícono de enlace roto si nunca terminó de conectarse.

Cambia el permiso de una API key. Haz clic en el ícono de edición de su tarjeta. Vuelve a abrir el mismo diálogo para elegir el tipo de permiso; elige el otro permiso y confirma.

Actualiza las credenciales de Canvas o D2L Brightspace. Haz clic en el ícono de edición de cualquiera de las dos tarjetas para volver a abrir los campos de credenciales y reconectar. Para cualquier otra integración, elimínala y crea una nueva si cambiaron los datos de conexión.

Reconfigura Sana. Su ícono de edición no toca la conexión en absoluto, abre la configuración de credenciales curso por curso.

Elimina una integración. Haz clic en el ícono de papelera de su tarjeta.

  • Una API key se elimina de inmediato, sin confirmación. Cualquier sistema que todavía la use para llamar a POK empieza a ser rechazado en el acto.
  • Un registro LTI activo te pide confirmar primero: "Estás por eliminar una integración en uso" y "Una vez eliminada, no podrás emitir certificados automáticamente desde esa plataforma." Uno que nunca terminó de conectarse se elimina de inmediato.
  • Una conexión de Sana siempre pide esa misma confirmación antes de eliminarse.

Una vez eliminada, la plataforma del otro lado ya no puede llegar a POK a través de ella, y la emisión automática desde esa fuente se detiene hasta que la conectes de nuevo.

"Integraciones" no aparece en mi menú

Solo el rol de administrador ve "Integraciones" en el menú de la barra superior. Si tienes el rol de operador o de lector, pídele a un administrador de tu organización que cree la integración por ti, o que te dé el rol de administrador. Consulta usuarios y permisos para ver qué puede hacer cada rol.

POK dice que la plataforma rechazó las credenciales

Esto aparece al conectar Canvas, D2L Brightspace o Moodle, las plataformas donde POK llama a la plataforma para validar lo que ingresaste:

  • "Por favor, revisa los datos ingresados e inténtalo nuevamente." Un error de validación genérico; revisa todos los campos.
  • "No pudimos conectarnos con esa plataforma. Revisa la URL y que el sitio sea accesible públicamente." POK no pudo llegar a la dirección que indicaste.
  • "La plataforma rechazó estas credenciales. Revisa el token o el secreto de cliente y que tenga los permisos necesarios." La dirección respondió, pero rechazó el token o el secreto de cliente.
  • "Esa dirección respondió, pero no es una plataforma con la que podamos integrarnos. Revisa que la URL apunte al LMS y que sea una versión compatible." Algo respondió, pero no es un LMS compatible.

Corrige el dato que señala el mensaje e inténtalo de nuevo. Si aparece un código de error propio de la plataforma debajo del mensaje, guárdalo a mano si contactas a soporte.