Flowkits
Ativar Flowkit (API Key)

6min
Ativando Flowkits via API Key
Para ativar Flowkits e seus fluxos associados por meio de uma API Key, você pode seguir este processo simples. Esta função é especialmente útil quando você deseja ativar vários fluxos de integração em um Workspace específico usando uma única API Key.
Passo 1: Requisição POST
Faça uma requisição POST para o seguinte endpoint:
JSON
POST - {{host}}/v1/activate
POST - {{host}}/v1/activate
﻿
Passo 2: Query Params
Certifique-se de incluir o parâmetro de consulta apikey, onde você deve fornecer a API Key necessária para autenticação. Um exemplo de como seria a URL completa:
JSON
http://{{host}}/v1/activate?apikey=a07b92c2-b597-4636-a449-208cd035b10d
http://{{host}}/v1/activate?apikey=a07b92c2-b597-4636-a449-208cd035b10d
﻿
Passo 3: Corpo da Requisição (Payload)
No corpo da sua requisição POST, você precisará fornecer os detalhes do Flowkit que deseja ativar. Eis um exemplo de como esse payload pode ser estruturado em JSON:
JSON
{
  "_id": "# id da entidade do flowkit",
  "name": "flowkit 01 # nome único do flowkit",
  "description": "# descrição do flowkit",
  "doc_url": "# URL da documentação do flowkit para importar na tela de detalhes",
  "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
    }
  ]
}

{
  "_id": "# id da entidade do flowkit",
  "name": "flowkit 01 # nome único do flowkit",
  "description": "# descrição do flowkit",
  "doc_url": "# URL da documentação do flowkit para importar na tela de detalhes",
  "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
    }
  ]
}
﻿
Passo 4: Respostas Possíveis
Dependendo do resultado da sua solicitação, você pode receber diferentes respostas:
Código de Resposta 201: Indica que a ativação foi bem-sucedida, sem conteúdo adicional.
Código de Resposta 400: Isso pode ocorrer se algum cabeçalho de informação estiver faltando na sua solicitação. A mensagem detalhada explicará o que está faltando.
Código de Resposta 500: Se ocorrer um erro interno no servidor durante o processo de ativação, você receberá esse código. A mensagem detalhada indicará o problema.
Exemplo de Requisição via cURL
Aqui está um exemplo de como fazer a requisição via cURL:
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 # nome único do flowkit",
  "description": "# descrição do flowkit",
  "doc_url": "# URL da documentação do flowkit para importar na tela de detalhes",
  "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
    }
  ]
}'

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 # nome único do flowkit",
  "description": "# descrição do flowkit",
  "doc_url": "# URL da documentação do flowkit para importar na tela de detalhes",
  "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
    }
  ]
}'
﻿
Certifique-se de substituir {{host}} pela URL correta do seu ambiente.
Essa funcionalidade oferece uma maneira eficiente de ativar fluxos em massa usando uma API Key, simplificando ainda mais o gerenciamento dos seus Flowkits.
Updated 16 Oct 2023
Did this page help you?
Ativando um Flowkit (Painel Fluid)
Parâmetros