API REST
La API REST de Go AMS permite integrar la plataforma con sus propios sistemas y aplicaciones. Con ella, puede crear, monitorear y gestionar automatizaciones de forma programática.
Visión general
La API REST es un recurso disponible para cuentas Persona Jurídica (PJ). Para utilizarla, es necesario generar una API Key desde un Tenant. Con esta clave, puede autenticar solicitudes y acceder a todas las rutas disponibles.
Explorar la documentación completa en SwaggerCómo obtener acceso
Tener una cuenta Persona Jurídica
La API está disponible solo para cuentas PJ. Si posee una cuenta PF, no tendrá acceso a este recurso.
Crear un Tenant
Dentro de su cuenta PJ, cree un Tenant (ambiente aislado). El Tenant es donde se generará la API Key.
Generar la API Key
En las configuraciones del Tenant, genere la API Key. Esta clave se usará en el header de autenticación de todas sus solicitudes.
Usar en las solicitudes
Incluya la API Key en el header de autenticación para acceder a las rutas de la API.
Autenticación
Todas las solicitudes a la API deben incluir la API Key en el header de autenticación. La clave identifica el Tenant y concede acceso a los recursos de ese ambiente.
Principales rutas
La API ofrece rutas para gestionar los principales recursos de la plataforma:
Procesos
Listar, crear y gestionar procesos de automatización.
GET /processes — Listar todos los procesos
POST /processes — Crear un nuevo proceso
products.api.routeProcessEx3
Jobs
Crear jobs, monitorear ejecuciones y consultar resultados.
GET /jobs — Listar todos los jobs
POST /jobs — Crear un nuevo job
products.api.routeJobEx3
Runners
Consultar estado e información de los Runners registrados.
GET /runners — Listar Runners
products.api.routeRunnerEx2
products.api.routeRunnerEx3
Colas
Gestionar colas y consultar ítems procesados.
GET /queues — Listar colas
POST /queues — Crear una cola
products.api.routeQueueEx3
Agendamientos
Crear y gestionar agendamientos automáticos.
GET /schedules — Listar agendamientos
POST /schedules — Crear un agendamiento
products.api.routeScheduleEx3
Assets
Gestionar recursos compartidos.
GET /assets — Listar assets
POST /assets — Crear un asset
products.api.routeAssetEx3
Importante
Las rutas y ejemplos anteriores son ilustrativos. Consulte la documentación completa de la API dentro de la plataforma para endpoints actualizados, parámetros y ejemplos detallados.
Límites y buenas prácticas
Al utilizar la API, considere los siguientes puntos:
Mantenga su API Key segura — no la exponga en repositorios públicos o código client-side.
Cada API Key está vinculada a un Tenant específico y accede solo a los recursos de ese Tenant.
Las solicitudes están sujetas a rate limiting. Evite enviar muchas solicitudes simultáneas.
Use la API para automatización e integración — para uso manual, prefiera la interfaz de la plataforma.