Claves API
Las claves API permiten que una aplicación externa aprobada intercambie información con su espacio de trabajo Versafy (por ejemplo, un portal de soporte interno o un flujo de trabajo de informes) sin utilizar el inicio de sesión de un compañero de equipo. Debido a que una clave otorga acceso continuo, cree una solo para una aplicación y un propietario conocidos.
Navegación: Abierto Varios → Claves API.
La página aparece solo para los usuarios autorizados a administrar claves API.
Crear una clave API
Cree una clave separada para cada aplicación y entorno para que pueda identificar su propósito y revocarla sin interrumpir el trabajo no relacionado.
- Seleccionar Nueva clave API.
- Introduzca un nombre claro que identifique la aplicación y el entorno.
- Crea la clave.
- Cópialo inmediatamente.
- Guárdelo en un administrador de contraseñas aprobado o en un almacén secreto de implementación.
El secreto completo se muestra sólo una vez. Versafy no puede volver a mostrarlo más tarde.
Nombra las claves claramente
Utilice nombres como Portal de soporte — producción o Exportación de informes: prueba. Evite nombres que contengan contraseñas, datos de clientes o el secreto mismo.
Cree claves separadas para aplicaciones y entornos separados. Esto le permite revocar una integración sin interrumpir otras.
Utilice las llaves de forma segura
- Nunca coloque una clave en las instrucciones del agente, la base de conocimientos, capturas de pantalla, mensajes de chat o código fuente comprometido en un repositorio.
- Nunca utilice una ubicación del lado del navegador o de un sitio web público donde los visitantes puedan inspeccionarlo.
- Compártelo únicamente a través de un proceso de gestión de secretos aprobado.
- Trate los registros copiados y los informes de errores como potencialmente confidenciales.
Consulte la referencia API Versafy de su organización para ver ejemplos de solicitudes y operaciones disponibles.
Revocar una clave API
Seleccionar Revocar para obtener la clave exacta y confirmar. La revocación entra en vigor inmediatamente para las aplicaciones que la utilizan.
Si es posible que una clave haya quedado expuesta, revoquela primero, cree una de reemplazo, actualice la aplicación externa y revise la actividad relevante.
Solucionar problemas de acceso a API
La clave no fue copiada.
Revocar la clave inutilizable y crear una nueva. El secreto original no puede volver a revelarse.
Una aplicación pierde el acceso
Confirme que su clave no fue revocada, que la clave de espacio de trabajo correcta esté configurada y que la operación API del cliente solicitada esté disponible para esa integración.