Qué es la API
FiveGuardian5 ofrece una API REST que permite realizar por programa las mismas tareas que se hacen en el panel: consultar equipos, administrar usuarios y grupos, crear políticas, etc. Es útil para integrar FiveGuardian5 con otros sistemas de la organización o para automatizar tareas repetitivas, como incorporar o retirar personal.
La API se accede a través del mismo dominio del panel, https://twh.fiveguardian5.com, siempre mediante HTTPS y con una credencial válida.
Credenciales de acceso
Cada solicitud a la API debe llevar un token de acceso. Hay dos opciones:
- Token personal de un usuario: actúa con los permisos de ese usuario. Útil para pruebas o tareas puntuales.
- Usuario de servicio: una cuenta técnica creada en Team › Service Users, con su propio rol y sus propios tokens. Es la opción recomendada para automatizaciones permanentes, porque no depende de una persona que pueda dejar la organización.
Al crear un token, elija una fecha de expiración. El valor del token se muestra una sola vez; guárdelo de inmediato en un gestor de secretos.
Permisos
Los tokens heredan el rol de su usuario. Asigne a cada usuario de servicio el rol mínimo que necesita la automatización. Por ejemplo, una integración que solo lee el inventario de equipos no necesita permisos para modificar políticas. Revise el alcance de los roles en Settings › Permissions.
Buenas prácticas
- Use un usuario de servicio distinto para cada integración, con un nombre que indique su propósito.
- Defina expiraciones y rote los tokens periódicamente.
- Pruebe primero las automatizaciones en modo de solo lectura.
- Las acciones hechas mediante la API quedan registradas en Audit Events a nombre del usuario o usuario de servicio que las realizó.
- Antes de automatizar cambios que afecten a muchos usuarios (políticas, DNS, rutas), consulte al equipo de soporte de FiveGuardian5.
Para la referencia de los métodos disponibles, solicite la documentación de la API a través de Soporte.