Criar uma configuração de provider

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "apiKey": "cs-key-abc123",
    "environment": "production"
  },
  "name": "ClearSale Production",
  "allowedHosts": [
    "api.acme.com",
    ".kyc-provider.io"
  ],
  "allowedPrivateHosts": [
    "nginx.pix-inline.internal"
  ],
  "kind": "external_openapi",
  "description": "ClearSale anti-fraud for Pix transactions",
  "metadata": {
    "environment": "production",
    "team": "risk"
  },
  "providerId": "clearsale",
  "schemaBindings": [
    {
      "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
      "type": "openapi",
      "operations": [
        {
          "method": "POST",
          "path": "/payments"
        }
      ]
    }
  ]
}
'

import requests

url = "https://flowker.sandbox.lerian.net/v1/provider-configurations"

payload = {
    "config": {
        "baseUrl": "https://api.clearsale.com.br",
        "apiKey": "cs-key-abc123",
        "environment": "production"
    },
    "name": "ClearSale Production",
    "allowedHosts": ["api.acme.com", ".kyc-provider.io"],
    "allowedPrivateHosts": ["nginx.pix-inline.internal"],
    "kind": "external_openapi",
    "description": "ClearSale anti-fraud for Pix transactions",
    "metadata": {
        "environment": "production",
        "team": "risk"
    },
    "providerId": "clearsale",
    "schemaBindings": [
        {
            "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
            "type": "openapi",
            "operations": [
                {
                    "method": "POST",
                    "path": "/payments"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: {
      baseUrl: 'https://api.clearsale.com.br',
      apiKey: 'cs-key-abc123',
      environment: 'production'
    },
    name: 'ClearSale Production',
    allowedHosts: ['api.acme.com', '.kyc-provider.io'],
    allowedPrivateHosts: ['nginx.pix-inline.internal'],
    kind: 'external_openapi',
    description: 'ClearSale anti-fraud for Pix transactions',
    metadata: {environment: 'production', team: 'risk'},
    providerId: 'clearsale',
    schemaBindings: [
      {
        schemaId: '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
        type: 'openapi',
        operations: [{method: 'POST', path: '/payments'}]
      }
    ]
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/provider-configurations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flowker.sandbox.lerian.net/v1/provider-configurations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => [
        'baseUrl' => 'https://api.clearsale.com.br',
        'apiKey' => 'cs-key-abc123',
        'environment' => 'production'
    ],
    'name' => 'ClearSale Production',
    'allowedHosts' => [
        'api.acme.com',
        '.kyc-provider.io'
    ],
    'allowedPrivateHosts' => [
        'nginx.pix-inline.internal'
    ],
    'kind' => 'external_openapi',
    'description' => 'ClearSale anti-fraud for Pix transactions',
    'metadata' => [
        'environment' => 'production',
        'team' => 'risk'
    ],
    'providerId' => 'clearsale',
    'schemaBindings' => [
        [
                'schemaId' => '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
                'type' => 'openapi',
                'operations' => [
                                [
                                                                'method' => 'POST',
                                                                'path' => '/payments'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/provider-configurations"

	payload := strings.NewReader("{\n  \"config\": {\n    \"baseUrl\": \"https://api.clearsale.com.br\",\n    \"apiKey\": \"cs-key-abc123\",\n    \"environment\": \"production\"\n  },\n  \"name\": \"ClearSale Production\",\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"kind\": \"external_openapi\",\n  \"description\": \"ClearSale anti-fraud for Pix transactions\",\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"team\": \"risk\"\n  },\n  \"providerId\": \"clearsale\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flowker.sandbox.lerian.net/v1/provider-configurations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": {\n    \"baseUrl\": \"https://api.clearsale.com.br\",\n    \"apiKey\": \"cs-key-abc123\",\n    \"environment\": \"production\"\n  },\n  \"name\": \"ClearSale Production\",\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"kind\": \"external_openapi\",\n  \"description\": \"ClearSale anti-fraud for Pix transactions\",\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"team\": \"risk\"\n  },\n  \"providerId\": \"clearsale\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flowker.sandbox.lerian.net/v1/provider-configurations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": {\n    \"baseUrl\": \"https://api.clearsale.com.br\",\n    \"apiKey\": \"cs-key-abc123\",\n    \"environment\": \"production\"\n  },\n  \"name\": \"ClearSale Production\",\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"kind\": \"external_openapi\",\n  \"description\": \"ClearSale anti-fraud for Pix transactions\",\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"team\": \"risk\"\n  },\n  \"providerId\": \"clearsale\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2026-03-17T14:00:00Z",
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "status": "active"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

POST

provider-configurations

Criar uma configuração de provider

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "apiKey": "cs-key-abc123",
    "environment": "production"
  },
  "name": "ClearSale Production",
  "allowedHosts": [
    "api.acme.com",
    ".kyc-provider.io"
  ],
  "allowedPrivateHosts": [
    "nginx.pix-inline.internal"
  ],
  "kind": "external_openapi",
  "description": "ClearSale anti-fraud for Pix transactions",
  "metadata": {
    "environment": "production",
    "team": "risk"
  },
  "providerId": "clearsale",
  "schemaBindings": [
    {
      "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
      "type": "openapi",
      "operations": [
        {
          "method": "POST",
          "path": "/payments"
        }
      ]
    }
  ]
}
'

import requests

url = "https://flowker.sandbox.lerian.net/v1/provider-configurations"

payload = {
    "config": {
        "baseUrl": "https://api.clearsale.com.br",
        "apiKey": "cs-key-abc123",
        "environment": "production"
    },
    "name": "ClearSale Production",
    "allowedHosts": ["api.acme.com", ".kyc-provider.io"],
    "allowedPrivateHosts": ["nginx.pix-inline.internal"],
    "kind": "external_openapi",
    "description": "ClearSale anti-fraud for Pix transactions",
    "metadata": {
        "environment": "production",
        "team": "risk"
    },
    "providerId": "clearsale",
    "schemaBindings": [
        {
            "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
            "type": "openapi",
            "operations": [
                {
                    "method": "POST",
                    "path": "/payments"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: {
      baseUrl: 'https://api.clearsale.com.br',
      apiKey: 'cs-key-abc123',
      environment: 'production'
    },
    name: 'ClearSale Production',
    allowedHosts: ['api.acme.com', '.kyc-provider.io'],
    allowedPrivateHosts: ['nginx.pix-inline.internal'],
    kind: 'external_openapi',
    description: 'ClearSale anti-fraud for Pix transactions',
    metadata: {environment: 'production', team: 'risk'},
    providerId: 'clearsale',
    schemaBindings: [
      {
        schemaId: '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
        type: 'openapi',
        operations: [{method: 'POST', path: '/payments'}]
      }
    ]
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/provider-configurations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flowker.sandbox.lerian.net/v1/provider-configurations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => [
        'baseUrl' => 'https://api.clearsale.com.br',
        'apiKey' => 'cs-key-abc123',
        'environment' => 'production'
    ],
    'name' => 'ClearSale Production',
    'allowedHosts' => [
        'api.acme.com',
        '.kyc-provider.io'
    ],
    'allowedPrivateHosts' => [
        'nginx.pix-inline.internal'
    ],
    'kind' => 'external_openapi',
    'description' => 'ClearSale anti-fraud for Pix transactions',
    'metadata' => [
        'environment' => 'production',
        'team' => 'risk'
    ],
    'providerId' => 'clearsale',
    'schemaBindings' => [
        [
                'schemaId' => '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
                'type' => 'openapi',
                'operations' => [
                                [
                                                                'method' => 'POST',
                                                                'path' => '/payments'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flowker.sandbox.lerian.net/v1/provider-configurations"

	payload := strings.NewReader("{\n  \"config\": {\n    \"baseUrl\": \"https://api.clearsale.com.br\",\n    \"apiKey\": \"cs-key-abc123\",\n    \"environment\": \"production\"\n  },\n  \"name\": \"ClearSale Production\",\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"kind\": \"external_openapi\",\n  \"description\": \"ClearSale anti-fraud for Pix transactions\",\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"team\": \"risk\"\n  },\n  \"providerId\": \"clearsale\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flowker.sandbox.lerian.net/v1/provider-configurations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": {\n    \"baseUrl\": \"https://api.clearsale.com.br\",\n    \"apiKey\": \"cs-key-abc123\",\n    \"environment\": \"production\"\n  },\n  \"name\": \"ClearSale Production\",\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"kind\": \"external_openapi\",\n  \"description\": \"ClearSale anti-fraud for Pix transactions\",\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"team\": \"risk\"\n  },\n  \"providerId\": \"clearsale\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flowker.sandbox.lerian.net/v1/provider-configurations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": {\n    \"baseUrl\": \"https://api.clearsale.com.br\",\n    \"apiKey\": \"cs-key-abc123\",\n    \"environment\": \"production\"\n  },\n  \"name\": \"ClearSale Production\",\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"kind\": \"external_openapi\",\n  \"description\": \"ClearSale anti-fraud for Pix transactions\",\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"team\": \"risk\"\n  },\n  \"providerId\": \"clearsale\",\n  \"schemaBindings\": [\n    {\n      \"schemaId\": \"018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8\",\n      \"type\": \"openapi\",\n      \"operations\": [\n        {\n          \"method\": \"POST\",\n          \"path\": \"/payments\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2026-03-17T14:00:00Z",
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "status": "active"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

{
  "code": "FLK-0001",
  "detail": "name is a required field",
  "errors": [
    {
      "location": "body.nodes",
      "message": "expected array length >= 1",
      "value": "<unknown>"
    }
  ],
  "instance": "/v1/workflows",
  "status": 400,
  "title": "Bad Request",
  "type": "https://errors.lerian.studio/v1/FLK-0001"
}

Autorizações

Authorization

string

header

obrigatório

Token bearer JWT emitido pelo provider de identidade. Envie-o no cabeçalho Authorization como Bearer <token>.

Corpo

application/json

Corpo da solicitação contendo os detalhes da configuração de provider.

config

object

obrigatório

Configuração específica do provider que é validada contra o JSON Schema do provider.

Show child attributes

Exemplo:

{
  "baseUrl": "https://api.clearsale.com.br",
  "apiKey": "cs-key-abc123",
  "environment": "production"
}

name

string

obrigatório

Nome único para esta configuração de provider.

Required string length: 1 - 100

Exemplo:

"ClearSale Production"

allowedHosts

string[] | null

Lista de hosts de destino permitidos para as chamadas de saída. Vale para todos os nodes que chamam por meio desta configuração. Omita o campo, ou envie uma lista vazia, para aceitar qualquer host público. O conector HTTP genérico, com id de provider http, é a exceção — ele recusa uma lista vazia com o erro FLK-0323. Um ponto inicial casa com subdomínios, então ".kyc-provider.io" casa com "api.kyc-provider.io". As entradas são apenas nomes de host, sem literal de IP, sem curinga e sem porta. O Flowker converte cada entrada para minúsculas. O Flowker verifica contra esta lista os valores base_url, onboarding_base_url e transaction_base_url de config e, em tempo de execução, verifica a URL da requisição e cada salto de redirecionamento.

Maximum array length: 100

Maximum string length: 253

Exemplo:

["api.acme.com", ".kyc-provider.io"]

allowedPrivateHosts

string[] | null

Conjunto de hosts privados permitidos, gerenciado pela sua equipe de operações. Uma entrada permite que esta configuração chame um host que resolve para um endereço privado ou de loopback, que o Flowker bloqueia por padrão. Endereços de metadados de nuvem e link-local continuam bloqueados, e nenhuma entrada os alcança. As entradas seguem o mesmo formato de allowedHosts.

Maximum array length: 100

Maximum string length: 253

Exemplo:

["nginx.pix-inline.internal"]

kind

enum<string>

Que tipo de conexão esta é. Omita, ou envie "catalog", para uma conexão a um provider do catálogo — nesse caso providerId é obrigatório. Envie "external_openapi" para uma conexão a um documento OpenAPI que você subiu pelo registro de schemas OpenAPI; providerId é opcional para esse kind, e o config dele contém openapi_schema_id mais um bloco auth e um base_url opcionais. Você escolhe o kind ao criar a configuração.

Opções disponíveis:

catalog,

external_openapi

Exemplo:

"external_openapi"

description

string

Descrição legível por humanos desta configuração de provider.

Maximum string length: 500

Exemplo:

"ClearSale anti-fraud for Pix transactions"

metadata

object

Pares chave-valor personalizados para etiquetagem.

Show child attributes

Exemplo:

{
  "environment": "production",
  "team": "risk"
}

providerId

string

ID do provider do catálogo a ser configurado. Ele é obrigatório para o kind catalog, e o Flowker recusa com o erro FLK-0297 uma criação que o omite. Uma configuração de kind external_openapi pode omiti-lo, e uma leitura dessa configuração devolve o id reservado external.openapi.

Exemplo:

"clearsale"

schemaBindings

object[] | null

Schemas armazenados aos quais esta configuração se vincula. Cada entrada nomeia um schema XSD ou OpenAPI já registrado no seu tenant. Omita o campo, ou envie uma lista vazia, para não ter vínculos. Duas entradas idênticas na mesma requisição são recusadas.

Maximum array length: 100

Show child attributes

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

createdAt

string<date-time>

Marca temporal de quando a configuração foi criada.

Exemplo:

"2026-03-17T14:00:00Z"

string<uuid>

Identificador único da configuração criada.

Exemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

name

string

Nome da configuração.

Exemplo:

"ClearSale Production"

status

string

Status inicial (sempre active na criação).

Exemplo:

"active"

Primeiros passos

API de Catálogo

API de Workflows

API de Agendamento

API de Execuções

API de Dashboards

API de Configurações de Executor

API de Configurações de Provider

API de Registro de Esquemas

API de Esquemas OpenAPI

API de Esquemas XSD

API de Webhooks

Tratamento de erros

Criar uma configuração de provider

Autorizações

Corpo

Resposta