Flowkits
Ativando um Flowkit
Ativando Flowkit (API Key)
11 min
ativando um flowkit por api key a ativação via api key é indicada quando você precisa automatizar a ativação de flowkits programaticamente — por exemplo, em pipelines de onboarding de clientes, integrações com sistemas externos ou ativações em massa em múltiplos workspaces prefere ativar pelo painel visual? consulte https //docs fluidapi io/ativando um flowkit console endpoint post {{host}}/v1/activate autenticação inclua sua api key como query parameter ?apikey={sua api key} exemplo de url completa http //{{host}}/v1/activate?apikey=a07b92c2 b597 4636 a449 208cd035b10d para gerar ou gerenciar suas api keys, consulte https //docs fluidapi io/api keys payload envie os detalhes do flowkit no corpo da requisição em json { "id" "# id da entidade do flowkit", "name" "flowkit 01", "description" "# descrição do flowkit", "doc url" "# url da documentação do flowkit", "revision" 1, "connections" \[ { "key" "bling", "connector slug" "bling", "label" "conexão com erp" } ], "params" \[ { "key" "sheet id", "type" "number", "required" true, "description" "" } ], "flows" \[ { "flow name" "# identificador do nome único do flow (meta flow name)", "flow revision" 1 } ] } campos do payload campo tipo descrição id string id da entidade do flowkit name string nome único do flowkit neste workspace description string descrição do propósito da ativação doc url string url da documentação do flowkit (importada na tela de detalhes) revision number versão do flowkit a ser ativada connections array lista de conexões necessárias para os conectores do flowkit params array lista de parâmetros configuráveis desta ativação flows array lista de fluxos a serem ativados, com nome e revisão respostas código significado 201 ativação realizada com sucesso 400 requisição inválida — algum campo obrigatório está ausente ou incorreto a mensagem de erro detalha o que está faltando 500 erro interno no servidor durante o processo de ativação a mensagem detalha o problema exemplo com curl curl location 'http //{{host}}/v1/activate?apikey=consumer01 api key 01' \\ \ header 'content type application/json' \\ \ data '{ "id" "# id da entidade do flowkit", "name" "flowkit 01", "description" "# descrição do flowkit", "doc url" "# url da documentação", "revision" 1, "connections" \[ { "key" "bling", "connector slug" "bling", "label" "conexão com erp" } ], "params" \[ { "key" "sheet id", "type" "number", "required" true, "description" "" } ], "flows" \[ { "flow name" "# identificador do nome único do flow", "flow revision" 1 } ] }' substitua {{host}} pela url do seu ambiente antes de executar