2FinanceDocs
Guias

Criar e ativar uma automação

Um fluxo end-to-end usando preview de agenda, criação, ativação e polling da operação.

Objetivo

Criar uma automação diária em shadow mode e ativá-la depois de conferir a agenda normalizada.

Pré-requisitos

O serviço deve estar em http://localhost:8080. Use um tenant, um ator e uma chave de idempotência únicos para cada mutação lógica.

1. Confira a agenda

curl -X POST http://localhost:8080/v1/automations/schedule:preview \
  -H 'Content-Type: application/json' \
  -H 'X-Tenant-ID: demo' \
  -d '{"Input":"todos os dias às 9h","Timezone":"America/Sao_Paulo"}'

2. Crie a automação

curl -X POST http://localhost:8080/v1/automations \
  -H 'Content-Type: application/json' \
  -H 'X-Tenant-ID: demo' \
  -H 'X-Actor-ID: demo-user' \
  -H 'Idempotency-Key: tutorial-create-report-v1' \
  -d '{
    "name":"Relatório diário",
    "schedule_input":"todos os dias às 9h",
    "timezone":"America/Sao_Paulo",
    "actions":[{"type":"report","name":"Gerar relatório"}],
    "desired_executor":"internal"
  }'

Guarde o automation.id, o latest_version.id e a revision retornados.

3. Ative

curl -X POST http://localhost:8080/v1/automations/AUTOMATION_ID:activate \
  -H 'Content-Type: application/json' \
  -H 'X-Tenant-ID: demo' \
  -H 'X-Actor-ID: demo-user' \
  -H 'Idempotency-Key: tutorial-activate-report-v1' \
  -H 'If-Match: REVISION' \
  -d '{"version_id":"VERSION_ID"}'

Verificação

O comando pode retornar 202 com uma operação. Consulte GET /v1/operations/{id} até state chegar a succeeded, então leia a automação novamente.

O que aconteceu internamente?

A API persistiu uma operação e uma mensagem de outbox. O worker publicou a versão no provider interno, confirmou o checksum observado, concluiu a operação e ativou o agendamento. O executor interno é shadow-only: este tutorial não gera efeito financeiro externo.

Nesta página

Ver OpenAPI