post
https://gateway.besinky.com/api/sandbox/studio/workflow//test
Executa um workflow em ambiente de teste e retorna o jobId com o status inicial.
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | string (body) | Identificador único do workflow que será testado. |
Autenticação
Todos os endpoints do Sinky Studio exigem um header de API Key:
x‑api-key: sua-api-key-aqui
O valor deve ser obtido no painel administrativo da sua conta.
Requisição
O corpo (body) deve conter um objeto JSON com a estrutura abaixo.
Os campos são obrigatórios conforme definidos no workflow; valores opcionais podem ser incluídos de acordo com a configuração do Input do workflow.
| Campo | Tipo | Descrição |
|---|---|---|
inputData | object | Parâmetros que alimentam o workflow (ex.: documentos, valores, objetos). Pode conter strings, números ou objetos aninhados conforme foi configurado no Nó Input do seu workflow. |
metadata | object | Objeto livre para controle interno do usuário; os dados enviados aqui serão retornados em todas as respostas relacionadas ao workflow (ex.: source, requestId). |
O campo
inputDataé opcional e deve conter exatamente os dados esperados pelo workflow configurado.
Resposta
A API devolve um objeto JSON contendo informações sobre a execução do teste:
| Campo | Tipo | Descrição |
|---|---|---|
jobId | string | Identificador interno do job criado. |
status | string | Estado inicial da execução. |
message | string | Mensagem de confirmação ou erro (opcional). |
data | object | Informações adicionais sobre o job (opcional). |
Observações
- Este endpoint executa o workflow em modo de teste, permitindo validação sem afetar o ambiente de produção.
- Se algum parâmetro obrigatório estiver faltando ou inválido, a API retornará um erro 400 com mensagem explicativa.
- O campo
inputDataé opcional e deve seguir a estrutura esperada pelo workflow.
