⌘ KDo arquivo ao resultado
Uma chamada no seu código cuida de todo o percurso. O contrato HTTP tem apenas envio, acompanhamento e recebimento.
Nesta página
1. Envie os arquivos à automação
Envie um formulário multipart com a versão publicada em version e um ou mais arquivos em files para POST /automations/:id/runs. A API calcula a quantidade e os bytes recebidos, confirma os envios internamente e inicia o processamento.
Use uma Idempotency-Key por envio lógico. Em caso de falha de rede, preserve essa chave e exatamente os mesmos arquivos para recuperar a execução.
2. Acompanhe a execução
HTTP 202 confirma o recebimento e o início do fluxo, com o ID da execução. Consulte GET /runs/:id até chegar a um estado final. Os adaptadores fazem isso automaticamente.
COMPLETED indica sucesso total. PARTIAL pode conter arquivos recebíveis e itens ou etapas com falha. FAILED, CANCELLED e EXPIRED não representam sucesso.
3. Receba os arquivos no seu sistema
Para cada item com result, GET /runs/:id/files/:fileId entrega os bytes por HTTPS com a mesma autenticação da API. Os adaptadores salvam cada resultado individualmente e retornam os caminhos ao seu código.
A biblioteca da conta não recebe os arquivos dessa execução. Preserve os resultados disponíveis, trate falhas por item e conclua o recebimento antes da expiração.