Executar cenário no Make, por uma API

Executa um cenário ativo agora, o que consome operações da organização. Retorna o executionId; com responsive true aguarda até 40 segundos e retorna também o status e as saídas do cenário. Uma organização ou time pausado responde 429 com o código IM310.

Identificador
make_run_scenario

A chamada

POST https://connect.reportei.com/api/tools/make_run_scenario/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "scenarioId": 1
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
scenarioIdintegerSimId of the scenario, from List scenarios.
dataobjectNãoValues of the scenario inputs, by input name. Required when the scenario has required inputs.
responsivebooleanNãoSet to true to wait for the end of the run. After 40 seconds the call times out, but the run goes on: follow it with Get scenario execution.

Conexões possíveis

O seu cliente conecta a conta do Make uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

Na conexão, o cliente informa também {zone}: o endereço da conta dele na API do app.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/make_run_scenario. Ele vira a definição de tool do seu agente sem conversão.

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.