API Reference
Esta secao orienta como integrar sua esteira com a plataforma Rapitify.
Quando usar a API
Use a API quando voce precisa:
- Criar ou atualizar flows por automacao
- Integrar deploy/publicacao com pipeline
- Disparar simulacoes em rotinas de validacao
- Sincronizar dados com sistemas externos
Fluxo recomendado de integracao
- Autenticar chamadas com credenciais seguras.
- Criar ou atualizar o flow.
- Rodar simulacao com payload representativo.
- Publicar versao aprovada.
- Monitorar execucoes e erros.
Preview no FlowBuilder
Este exemplo abre direto no FlowBuilder embedado. A visualizacao em Fluxo/JSON, simulacao e operacoes do flow ficam dentro do proprio editor.
Nao foi possivel carregar o preview embedado automaticamente.
Boas praticas
- Sempre validar antes de publicar.
- Evitar credenciais hardcoded no codigo.
- Usar versionamento de payloads criticos.
- Registrar correlacao entre chamada e execucao.
O que evolui nesta documentacao
As proximas iteracoes desta secao vao detalhar:
- Endpoints por dominio (flow, simulacao, publicacao)
- Modelos de request/response
- Codigos de erro e estrategia de retry
- Exemplos de integracao para CI/CD
Proximo passo
Se voce quer operar Rapitify direto no editor, siga para MCP Server.