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 Ativando pelo 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 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.