Atualizar uma configuração de executor

curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/executors/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "authentication": {
    "type": "api_key",
    "config": {
      "key": "sk-live-abc123def456",
      "header": "X-API-Key"
    }
  },
  "baseUrl": "https://api.serasa.com.br/v2",
  "endpoints": [
    {
      "method": "POST",
      "name": "validate-identity",
      "path": "/identity/validate",
      "timeout": 30
    }
  ],
  "name": "Serasa KYC",
  "description": "Serasa KYC provider for identity validation",
  "metadata": {}
}
'

import requests

url = "https://flowker.sandbox.lerian.net/v1/executors/{id}"

payload = {
    "authentication": {
        "type": "api_key",
        "config": {
            "key": "sk-live-abc123def456",
            "header": "X-API-Key"
        }
    },
    "baseUrl": "https://api.serasa.com.br/v2",
    "endpoints": [
        {
            "method": "POST",
            "name": "validate-identity",
            "path": "/identity/validate",
            "timeout": 30
        }
    ],
    "name": "Serasa KYC",
    "description": "Serasa KYC provider for identity validation",
    "metadata": {}
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authentication: {type: 'api_key', config: {key: 'sk-live-abc123def456', header: 'X-API-Key'}},
    baseUrl: 'https://api.serasa.com.br/v2',
    endpoints: [
      {
        method: 'POST',
        name: 'validate-identity',
        path: '/identity/validate',
        timeout: 30
      }
    ],
    name: 'Serasa KYC',
    description: 'Serasa KYC provider for identity validation',
    metadata: {}
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/executors/{id}', 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/executors/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'authentication' => [
        'type' => 'api_key',
        'config' => [
                'key' => 'sk-live-abc123def456',
                'header' => 'X-API-Key'
        ]
    ],
    'baseUrl' => 'https://api.serasa.com.br/v2',
    'endpoints' => [
        [
                'method' => 'POST',
                'name' => 'validate-identity',
                'path' => '/identity/validate',
                'timeout' => 30
        ]
    ],
    'name' => 'Serasa KYC',
    'description' => 'Serasa KYC provider for identity validation',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/executors/{id}"

	payload := strings.NewReader("{\n  \"authentication\": {\n    \"type\": \"api_key\",\n    \"config\": {\n      \"key\": \"sk-live-abc123def456\",\n      \"header\": \"X-API-Key\"\n    }\n  },\n  \"baseUrl\": \"https://api.serasa.com.br/v2\",\n  \"endpoints\": [\n    {\n      \"method\": \"POST\",\n      \"name\": \"validate-identity\",\n      \"path\": \"/identity/validate\",\n      \"timeout\": 30\n    }\n  ],\n  \"name\": \"Serasa KYC\",\n  \"description\": \"Serasa KYC provider for identity validation\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.patch("https://flowker.sandbox.lerian.net/v1/executors/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authentication\": {\n    \"type\": \"api_key\",\n    \"config\": {\n      \"key\": \"sk-live-abc123def456\",\n      \"header\": \"X-API-Key\"\n    }\n  },\n  \"baseUrl\": \"https://api.serasa.com.br/v2\",\n  \"endpoints\": [\n    {\n      \"method\": \"POST\",\n      \"name\": \"validate-identity\",\n      \"path\": \"/identity/validate\",\n      \"timeout\": 30\n    }\n  ],\n  \"name\": \"Serasa KYC\",\n  \"description\": \"Serasa KYC provider for identity validation\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flowker.sandbox.lerian.net/v1/executors/{id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authentication\": {\n    \"type\": \"api_key\",\n    \"config\": {\n      \"key\": \"sk-live-abc123def456\",\n      \"header\": \"X-API-Key\"\n    }\n  },\n  \"baseUrl\": \"https://api.serasa.com.br/v2\",\n  \"endpoints\": [\n    {\n      \"method\": \"POST\",\n      \"name\": \"validate-identity\",\n      \"path\": \"/identity/validate\",\n      \"timeout\": 30\n    }\n  ],\n  \"name\": \"Serasa KYC\",\n  \"description\": \"Serasa KYC provider for identity validation\",\n  \"metadata\": {}\n}"

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

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "name": "Serasa KYC",
  "description": "Serasa identity validation service",
  "baseUrl": "https://api.serasa.com.br/v2",
  "endpoints": [
    {
      "name": "validate-identity",
      "path": "/identity/validate",
      "method": "POST",
      "timeout": 30
    }
  ],
  "authentication": {
    "type": "api_key",
    "config": {
      "key": "********",
      "header": "X-API-Key"
    }
  },
  "status": "active",
  "metadata": {},
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-16T09:30:00Z",
  "lastTestedAt": "2026-03-16T09:30:00Z"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

PATCH

executors

{id}

Atualizar uma configuração de executor

curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/executors/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "authentication": {
    "type": "api_key",
    "config": {
      "key": "sk-live-abc123def456",
      "header": "X-API-Key"
    }
  },
  "baseUrl": "https://api.serasa.com.br/v2",
  "endpoints": [
    {
      "method": "POST",
      "name": "validate-identity",
      "path": "/identity/validate",
      "timeout": 30
    }
  ],
  "name": "Serasa KYC",
  "description": "Serasa KYC provider for identity validation",
  "metadata": {}
}
'

import requests

url = "https://flowker.sandbox.lerian.net/v1/executors/{id}"

payload = {
    "authentication": {
        "type": "api_key",
        "config": {
            "key": "sk-live-abc123def456",
            "header": "X-API-Key"
        }
    },
    "baseUrl": "https://api.serasa.com.br/v2",
    "endpoints": [
        {
            "method": "POST",
            "name": "validate-identity",
            "path": "/identity/validate",
            "timeout": 30
        }
    ],
    "name": "Serasa KYC",
    "description": "Serasa KYC provider for identity validation",
    "metadata": {}
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authentication: {type: 'api_key', config: {key: 'sk-live-abc123def456', header: 'X-API-Key'}},
    baseUrl: 'https://api.serasa.com.br/v2',
    endpoints: [
      {
        method: 'POST',
        name: 'validate-identity',
        path: '/identity/validate',
        timeout: 30
      }
    ],
    name: 'Serasa KYC',
    description: 'Serasa KYC provider for identity validation',
    metadata: {}
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/executors/{id}', 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/executors/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'authentication' => [
        'type' => 'api_key',
        'config' => [
                'key' => 'sk-live-abc123def456',
                'header' => 'X-API-Key'
        ]
    ],
    'baseUrl' => 'https://api.serasa.com.br/v2',
    'endpoints' => [
        [
                'method' => 'POST',
                'name' => 'validate-identity',
                'path' => '/identity/validate',
                'timeout' => 30
        ]
    ],
    'name' => 'Serasa KYC',
    'description' => 'Serasa KYC provider for identity validation',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/executors/{id}"

	payload := strings.NewReader("{\n  \"authentication\": {\n    \"type\": \"api_key\",\n    \"config\": {\n      \"key\": \"sk-live-abc123def456\",\n      \"header\": \"X-API-Key\"\n    }\n  },\n  \"baseUrl\": \"https://api.serasa.com.br/v2\",\n  \"endpoints\": [\n    {\n      \"method\": \"POST\",\n      \"name\": \"validate-identity\",\n      \"path\": \"/identity/validate\",\n      \"timeout\": 30\n    }\n  ],\n  \"name\": \"Serasa KYC\",\n  \"description\": \"Serasa KYC provider for identity validation\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.patch("https://flowker.sandbox.lerian.net/v1/executors/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authentication\": {\n    \"type\": \"api_key\",\n    \"config\": {\n      \"key\": \"sk-live-abc123def456\",\n      \"header\": \"X-API-Key\"\n    }\n  },\n  \"baseUrl\": \"https://api.serasa.com.br/v2\",\n  \"endpoints\": [\n    {\n      \"method\": \"POST\",\n      \"name\": \"validate-identity\",\n      \"path\": \"/identity/validate\",\n      \"timeout\": 30\n    }\n  ],\n  \"name\": \"Serasa KYC\",\n  \"description\": \"Serasa KYC provider for identity validation\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flowker.sandbox.lerian.net/v1/executors/{id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authentication\": {\n    \"type\": \"api_key\",\n    \"config\": {\n      \"key\": \"sk-live-abc123def456\",\n      \"header\": \"X-API-Key\"\n    }\n  },\n  \"baseUrl\": \"https://api.serasa.com.br/v2\",\n  \"endpoints\": [\n    {\n      \"method\": \"POST\",\n      \"name\": \"validate-identity\",\n      \"path\": \"/identity/validate\",\n      \"timeout\": 30\n    }\n  ],\n  \"name\": \"Serasa KYC\",\n  \"description\": \"Serasa KYC provider for identity validation\",\n  \"metadata\": {}\n}"

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

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "name": "Serasa KYC",
  "description": "Serasa identity validation service",
  "baseUrl": "https://api.serasa.com.br/v2",
  "endpoints": [
    {
      "name": "validate-identity",
      "path": "/identity/validate",
      "method": "POST",
      "timeout": 30
    }
  ],
  "authentication": {
    "type": "api_key",
    "config": {
      "key": "********",
      "header": "X-API-Key"
    }
  },
  "status": "active",
  "metadata": {},
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-16T09:30:00Z",
  "lastTestedAt": "2026-03-16T09:30:00Z"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

{
  "code": "FLK-0001",
  "message": "Invalid input provided",
  "title": "Bad Request"
}

Autorizações

X-API-Key

string

header

obrigatório

Chave de API para autenticar as requisições à API do Flowker. Provisionada por meio da variável de ambiente API_KEY durante o deployment.

Parâmetros de caminho

string<uuid>

obrigatório

Identificador único da configuração do executor.

Corpo

application/json

Corpo da solicitação contendo os detalhes atualizados da configuração do executor.

authentication

object

obrigatório

Show child attributes

baseUrl

string

obrigatório

URL base do serviço externo.

Maximum string length: 500

Exemplo:

"https://api.serasa.com.br/v2"

endpoints

object[]

obrigatório

Lista de endpoints HTTP expostos por este executor.

Minimum array length: 1

Show child attributes

name

string

obrigatório

Nome de exibição da configuração do executor.

Required string length: 1 - 100

Exemplo:

"Serasa KYC"

description

string

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

Maximum string length: 500

Exemplo:

"Serasa KYC provider for identity validation"

metadata

object

Pares chave-valor personalizados para etiquetagem.

Show child attributes

Resposta

Indica que a solicitação foi bem-sucedida e a resposta contém os dados solicitados.

authentication

object

Show child attributes

baseUrl

string

URL base do serviço externo.

Exemplo:

"https://api.serasa.com.br/v2"

createdAt

string<date-time>

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

Exemplo:

"2026-03-15T10:00:00Z"

description

string

Descrição legível por humanos.

Exemplo:

"Serasa identity validation service"

endpoints

object[]

Lista de endpoints HTTP configurados.

Show child attributes

string<uuid>

Identificador único da configuração do executor.

Exemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

lastTestedAt

string<date-time>

Marca temporal do último teste de conectividade. Nulo se nunca testado.

Exemplo:

"2026-03-16T09:30:00Z"

metadata

object

Metadados personalizados.

Show child attributes

name

string

Nome de exibição.

Exemplo:

"Serasa KYC"

status

enum<string>

Status atual do ciclo de vida: unconfigured, configured, tested, active ou disabled.

Opções disponíveis:

unconfigured,

configured,

tested,

active,

disabled

Exemplo:

"active"

updatedAt

string<date-time>

Marca temporal da última atualização.

Exemplo:

"2026-03-16T09:30:00Z"

Obter uma configuração de executor

Excluir uma configuração de executor

⌘I

Primeiros passos

API de Catálogo

API de Workflows

API de Execuções

API de Dashboards

API de Configurações de Executor

API de Configurações de Provider

API de Auditoria

API de Webhooks

Tratamento de erros

Atualizar uma configuração de executor

Autorizações

Parâmetros de caminho

Corpo

Resposta