API REST
A API REST do Go AMS permite integrar a plataforma com seus próprios sistemas e aplicações. Com ela, você pode criar, monitorar e gerenciar automações programaticamente.
Visão geral
A API REST é um recurso disponível para contas Pessoa Jurídica (PJ). Para utilizá-la, é necessário gerar uma API Key a partir de uma Tenant. Com essa chave, você pode autenticar requisições e acessar todas as rotas disponíveis.
Explorar documentação completa no SwaggerComo obter acesso
Ter uma conta Pessoa Jurídica
A API está disponível apenas para contas PJ. Se você possui uma conta PF, não terá acesso a este recurso.
Criar uma Tenant
Dentro da sua conta PJ, crie uma Tenant (ambiente isolado). A Tenant é onde a API Key será gerada.
Gerar a API Key
Nas configurações da Tenant, gere a API Key. Essa chave será usada no header de autenticação de todas as suas requisições.
Usar nas requisições
Inclua a API Key no header de autenticação para acessar as rotas da API.
Autenticação
Todas as requisições à API devem incluir a API Key no header de autenticação. A chave identifica a Tenant e concede acesso aos recursos daquele ambiente.
Principais rotas
A API oferece rotas para gerenciar os principais recursos da plataforma:
Processos
Listar, criar e gerenciar processos de automação.
GET /processes — Listar todos os processos
POST /processes — Criar um novo processo
products.api.routeProcessEx3
Jobs
Criar jobs, monitorar execuções e consultar resultados.
GET /jobs — Listar todos os jobs
POST /jobs — Criar um novo job
products.api.routeJobEx3
Runners
Consultar status e informações dos Runners registrados.
GET /runners — Listar Runners
products.api.routeRunnerEx2
products.api.routeRunnerEx3
Filas
Gerenciar filas e consultar itens processados.
GET /queues — Listar filas
POST /queues — Criar uma fila
products.api.routeQueueEx3
Agendamentos
Criar e gerenciar agendamentos automáticos.
GET /schedules — Listar agendamentos
POST /schedules — Criar um agendamento
products.api.routeScheduleEx3
Assets
Gerenciar recursos compartilhados.
GET /assets — Listar assets
POST /assets — Criar um asset
products.api.routeAssetEx3
Importante
As rotas e exemplos acima são ilustrativos. Consulte a documentação completa da API dentro da plataforma para endpoints atualizados, parâmetros e exemplos detalhados.
Limites e boas práticas
Ao utilizar a API, considere os seguintes pontos:
Mantenha sua API Key segura — não exponha em repositórios públicos ou código client-side.
Cada API Key está vinculada a uma Tenant específica e acessa apenas os recursos daquela Tenant.
As requisições estão sujeitas a rate limiting. Evite enviar muitas requisições simultâneas.
Use a API para automação e integração — para uso manual, prefira a interface da plataforma.