Resumen
Una guía completa sobre cómo generar claves de API OAuth dentro de KnowledgeCity LMS, incluyendo cómo nombrar los tokens, ver los Client ID y gestionar las credenciales existentes de forma segura.
Introducción
La sección API Tokens dentro de KnowledgeCity LMS permite a los administradores con Full Access generar credenciales OAuth para el acceso seguro a la API. Estos tokens (Client ID y Client Secret) permiten que aplicaciones externas o integraciones personalizadas recuperen y gestionen datos de su LMS de acuerdo con los permisos otorgados. Esta guía lo lleva a través de la creación de su token de API, la comprensión de las implicaciones de seguridad y la gestión de los tokens existentes.
Requisitos
- Administrador de KnowledgeCity LMS con Full Access, o con un rol personalizado que otorgue la sección Integrations: Necesario para acceder a la configuración de Integrations y API Tokens.
- Integración de API: Una comprensión clara de qué herramienta o servicio externo utilizará las credenciales generadas.
- Documentación de la API: Todos los detalles sobre nuestra API están documentados aquí: https://integration.knowledgecity.com/#page=getting-started/about
Pasos a Seguir
Paso 1. Acceder a la Sección API Tokens
- Inicie sesión en su KnowledgeCity LMS con una cuenta que tenga Full Access.
- Ubique el menú desplegable Settings en el panel superior de la interfaz del LMS.
- En el menú desplegable, seleccione Integrations. Esto abrirá la página de detalles de Integrations.
- En la página de Integrations, seleccione la pestaña API Tokens. Aquí verá una lista de todos los tokens generados anteriormente y un botón para crear nuevos.
Paso 2. Crear un Nuevo Token de API
- Haga clic en el botón Create token. Aparecerá una ventana emergente para crear el nuevo token.
- En el campo Token name, ingrese un nombre descriptivo para su token (por ejemplo, "Nombre de Herramienta Externa - Sincronización de Datos de Curso"). Esto le ayuda a identificar el propósito del token más adelante.
- Lea atentamente la declaración de autorización y marque la casilla para confirmar su comprensión y autorización.
- Haga clic en el botón Create token para generar sus credenciales.
Importante: al crear un token de API, usted autoriza la generación de una clave de API OAuth para acceder a sus datos. Esta clave permitirá el acceso para recuperar y gestionar su información según lo permitido por la API. Usted es responsable de mantenerla segura. KnowledgeCity monitorea el uso de la API y puede deshabilitar la clave si se detecta un posible abuso.
Paso 3. Copiar sus Credenciales de Cliente
- Después de la creación, su nuevo token aparecerá en la lista de la página de detalles de API Tokens.
- Ubique la tarjeta de su nuevo token y luego copie el Client ID y el Client Secret para usarlos en su aplicación externa o herramienta de integración:
- Client ID: un identificador público único para su token. Esto le indica a la API qué aplicación está solicitando acceso.
- Client Secret: una clave privada utilizada para autenticar su aplicación. Piense en ella como una contraseña para su integración. Haga clic para copiarla y revelarla según sea necesario.
Importante: trate su Client Secret como una contraseña. Nunca lo comparta en foros públicos, correos electrónicos o código del lado del cliente. Si sospecha que ha sido comprometido, elimine el token inmediatamente y genere uno nuevo.
Paso 4. Gestionar los Tokens Existentes
- Viewing Tokens: todos los tokens activos se muestran como tarjetas en la página de detalles de API Tokens.
- Removing a Token: si un token ya no es necesario o sospecha que ha sido comprometido, puede revocarlo de inmediato.
- Encuentre la tarjeta del token en la lista.
- Haga clic en el botón Remove token ubicado en esa tarjeta.
- Confirme la eliminación.
Importante: eliminar un token de API es una acción irreversible y bloqueará inmediatamente el acceso de cualquier aplicación externa que use ese token.
Conclusión
Integrarse con KnowledgeCity LMS mediante tokens de API proporciona una forma segura y eficiente de conectar aplicaciones externas y herramientas personalizadas a su plataforma de aprendizaje. Siguiendo los pasos descritos anteriormente, los administradores con Full Access pueden generar, gestionar y almacenar de forma segura las credenciales necesarias, manteniendo el control sobre el acceso. Recuerde revisar regularmente sus tokens activos y eliminar los que ya no estén en uso para mantener su entorno de integración limpio y seguro.