Crear y gestionar claves de acceso a la API
- haritha.kothapalem (Unlicensed)
- sneha.tripathi
Este artículo describe el proceso para crear claves de acceso a la API y cómo se pueden definir las restricciones para el acceso de la clave de la API a las diferentes funcionalidades de Bot Builder. Las claves de acceso a la API permiten a los sistemas externos acceder a la plataforma de Luma Virtual Agent con la identificación y la autorización adecuadas.
Para acceder a las claves de acceso a la API, haga clic en Settings (Configuración) en el panel de navegación izquierdo de Bot Builder (Consola de Administración de Luma) como se muestra a continuación.
La cuadrícula de la página API Access Keys (Claves de acceso a la API) muestra la lista de claves de acceso a la API existentes. Para crear una nueva clave de acceso a la API, realice los siguientes pasos:
- Haga clic en Create API Key (Crear clave de la API).
- Ingrese el nombre de la clave nueva. El nombre de la clave proporciona una indicación sobre la integración o el uso de la clave.
- Seleccione Status (Estado) para la clave. Cuando se configura una clave como Inactive (Inactiva), se negará el acceso desde los sistemas externos.
- Haga clic en Next (Siguiente).
- Proporcione los permisos necesarios en la página Permisos. Los permisos definen qué módulos o funciones pueden utilizar las aplicaciones de llamada con la clave. Se puede otorgar a los permisos un nivel alto de acceso a todos los componentes de la gestión de la habilidad, los bots o los usuarios o la configuración del Tenant. Se pueden crear restricciones más granulares dentro de estas entidades. Por ejemplo, si desea designar la clave de acceso solo para gestionar usuarios, seleccione la casilla de verificación User Management (Gestión de usuarios).
Importante
Una vez se creó la clave de acceso a la API, se mostrará solo una vez. Después de cerrar la ventana emergente, no se volverá a mostrar y no estará disponible en la interfaz de usuario. Asegúrese de copiarla y guardarla de forma segura para usarla en las otras aplicaciones.
Uso de la clave de acceso a la API en el encabezado de solicitud de la API
Los campos siguientes se tienen que pasar como campos del encabezado en la solicitud de la API.
- ID externo del tenant. Este ID externo de tenant ayuda a identificar el tenant de la plataforma de Virtual Agent. El ID de tenant contiene 32 caracteres alfanuméricos. Por ejemplo: Luma-tenant-externalId: <19e8ce3e-dbdb-5ce0-9401-71ae207be52g >. Se puede recuperar el ID externo del tenant desde la página Tenant Information (información del tenant) en el menú Settings (Configuración).
- API Access Key Clave de acceso a la API: esta clave de acceso a la API ayuda a identificar y autorizar la aplicación externa. La clave de acceso a la API contiene 50 caracteres alfanuméricos. Por ejemplo: Luma-api-access-key: <A0k1wba7DWfCikyEfKgA8qrGUIwWMhxgjx0CsL5LRJtcXZT0aT>