API REST
Lanza formularios y gestiona AnsibleForms desde scripts
Para desarrolladores e ingenieros de automatización: lanza formularios y gestiona AnsibleForms desde scripts.
Todo lo que hace la interfaz web pasa por la API REST, así que los scripts y otras herramientas pueden hacer lo mismo.
Visión general
La API se sirve bajo /api/v2 en el servidor de AnsibleForms:
- Referencia completa : estas páginas cubren lo que más usan los scripts. Cada endpoint se describe, y se puede probar, en la página Swagger integrada del servidor,
https://<your server>/api/v2/docs. - Permisos : una llamada se ejecuta como el usuario cuyo token lleva, con los roles de ese usuario, igual que en el navegador.
- Validación del lanzamiento : los trabajos lanzados a través de la API se pueden comprobar como los lanzamientos desde el navegador (consulta Validación del lanzamiento).
- Límites de peticiones : solo están limitados los endpoints de inicio de sesión, cierre de sesión, renovación del token e inicio de sesión único, el cambio de contraseña (
PUT /api/v2/profile) y los endpoints de tokens de API (POSTyDELETE /api/v2/profile/tokens) (consulta Autenticación). Las demás llamadas no tienen límite de peticiones (el asistente de chat tiene límites propios), así que un script debería dosificar sus llamadas, por ejemplo cuando sigue un trabajo.
En esta sección
Cada tema tiene su propia página:
| Página | Qué cubre |
|---|---|
| Autenticación | Iniciar sesión, renovar el token o usar un token de larga duración |
| Trabajos | Lanzar un formulario, seguir el trabajo, abortarlo, relanzarlo o aprobarlo |
| Respuestas y errores | La forma de una respuesta y los códigos de estado |
| Eventos en directo | Enterarse de cuándo cambian los trabajos y los ajustes, en lugar de consultar periódicamente |