Executar via API (Standalone)

Executar via API (Standalone)

As automatizações standalone podem ser executadas diretamente por meio de uma chamada HTTP à API do Sytex. Isso permite integrar automatizações com sistemas externos, scripts, ou qualquer ferramenta capaz de fazer requisições HTTP.


Quando usar isso?

  • Quando um sistema externo precisa executar uma ação no Sytex (ex: um ERP que cria um workflow ao aprovar uma ordem de compra).
  • Para integrações entre diferentes plataformas.
  • Para automatizar processos que se iniciam fora do Sytex.


Como funciona?

    Crie uma automatização com os passos necessários e defina os parâmetros de entrada.
    Publique a automatização.
    Chame o endpoint da API do Sytex com os parâmetros obrigatórios.
A automatização é executada de forma assíncrona. Se você precisar de uma resposta imediata, pode adicionar um passo de Resposta HTTP ao final da automatização.


Resposta HTTP personalizada

Com a ação Resposta HTTP você pode retornar uma resposta personalizada ao sistema que fez a chamada:
  • Código de estado: 200 (OK), 201 (Criado), 204 (Sem conteúdo), 400 (Erro de requisição), 401 (Não autorizado), 403 (Proibido), 404 (Não encontrado), 500 (Erro do servidor)
  • Body JSON: dados estruturados que você queira retornar (ex: o ID do objeto criado)
Isso é especialmente útil para integrações bidirecionais onde o sistema externo precisa confirmar que a operação foi realizada corretamente.


Parâmetros de entrada via API

Os parâmetros são enviados no body da requisição HTTP como JSON. Cada parâmetro definido na automatização deve ser incluído com seu nome e valor.
Também é suportado o envio de arquivos por meio de multipart upload (veja a subpágina Executar via API com FILES).


Exemplo de uso

Um sistema externo quer criar um workflow no Sytex cada vez que um orçamento é aprovado:
    A automatização recebe como parâmetros: nome_projeto (texto), cliente (cliente), valor (número).
    Os passos: buscar projeto → criar workflow → atribuir equipe → resposta HTTP com o ID do workflow criado.
    O sistema externo faz um POST ao endpoint com os dados e recebe o ID do workflow como resposta.