Cada integración por API utilizada para conectar tu cuenta VTEX con sistemas externos requerirá la creación de una clave de API, que en inglés se denomina API key. Para cada clave, hay un token de API (o API token), que funciona como una contraseña para el uso de esa credencial.
Estas credenciales de autenticación se utilizan para garantizar acceso seguro a los datos que deseas compartir con las integraciones, sin exponer tu cuenta a aplicaciones o usuarios no autorizados.
Para que una clave de API pueda realizar con éxito requests de API a tu cuenta, debe estar activa y tener roles que especifiquen los recursos de la cuenta a los que tiene permiso para acceder.
Tipos de claves de API
Existen dos tipos de claves de aplicación: internas o externas. Esta definición depende de la cuenta que crea, gestiona y utiliza la credencial.
Claves internas
Las claves de API internas son credenciales generadas y gestionadas en tu cuenta VTEX. Esto significa que debes tener acceso a todos los pares de claves y tokens de API (el equivalente a los nombres de usuario y las contraseñas para las integraciones de API).
Claves externas
Las claves de API externas son credenciales generadas y administradas por otras cuentas VTEX. Al agregar roles a las claves de API (el equivalente a los nombres de usuario) proporcionadas por terceros, tienes la opción de permitir que accedan a recursos específicos de tu cuenta.
Gestionar claves de API
La página Claves de API del Admin VTEX te permite gestionar las claves de API con acceso a tu tienda. Consulta las guías a continuación para más detalles sobre la información y las acciones disponibles en esta página:
-
Exportar claves de API: permite descargar una plantilla con los datos de las claves de API generadas y externas.
-
Configuración: permite definir el periodo recomendado de renovación de tokens. Cuando se cumple el límite establecido para el token, la interfaz muestra una alerta de renovación. Esta configuración se aplica a todos los tokens de clave.
El token no vence después del plazo definido. La configuración solamente determina cuándo la interfaz recomendará la renovación.
-
Claves generadas: permite gestionar las claves de API creadas y administradas por tu cuenta VTEX.
-
Claves externas: permite gestionar claves de API creadas y administradas por otras cuentas VTEX, con acceso a recursos específicos de tu cuenta.
Requisitos para gestionar claves de API
Para gestionar claves de API, es obligatorio tener el rol User Administrator - RESTRICTED o un rol personalizado con los siguientes recursos:
- View API Keys (ver, filtrar, buscar, ordenar y exportar claves de API generadas y externas)
- Edit API Keys (crear, eliminar, cambiar el status y agregar o remover permisos)
- Renew API Token (ver y renovar tokens de claves generadas)
- Edit API Keys settings (editar configuración de la duración de tokens de claves generadas)
Aprende más sobre cada recurso en Recursos de License Manager.