Actualizar una configuración de ejecutor

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}

Actualizar una configuración de ejecutor

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"
}

Autorizaciones

X-API-Key

string

header

requerido

Clave de API para autenticar las solicitudes a la API de Flowker. Se aprovisiona mediante la variable de entorno API_KEY durante el despliegue.

Parámetros de ruta

string<uuid>

requerido

Identificador único de la configuración del ejecutor.

Cuerpo

application/json

Cuerpo de la solicitud que contiene los detalles actualizados de la configuración del ejecutor.

authentication

object

requerido

Show child attributes

baseUrl

string

requerido

URL base del servicio externo.

Maximum string length: 500

Ejemplo:

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

endpoints

object[]

requerido

Lista de endpoints HTTP expuestos por este ejecutor.

Minimum array length: 1

Show child attributes

name

string

requerido

Nombre para mostrar de la configuración del ejecutor.

Required string length: 1 - 100

Ejemplo:

"Serasa KYC"

description

string

Descripción legible por humanos de esta configuración de ejecutor.

Maximum string length: 500

Ejemplo:

"Serasa KYC provider for identity validation"

metadata

object

Pares clave-valor personalizados para etiquetado.

Show child attributes

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos solicitados.

authentication

object

Show child attributes

baseUrl

string

URL base del servicio externo.

Ejemplo:

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

createdAt

string<date-time>

Marca de tiempo de cuando se creó la configuración.

Ejemplo:

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

description

string

Descripción legible por humanos.

Ejemplo:

"Serasa identity validation service"

endpoints

object[]

Lista de endpoints HTTP configurados.

Show child attributes

string<uuid>

Identificador único de la configuración del ejecutor.

Ejemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

lastTestedAt

string<date-time>

Marca de tiempo de la última prueba de conectividad. Nulo si nunca se probó.

Ejemplo:

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

metadata

object

Metadatos personalizados.

Show child attributes

name

string

Nombre para mostrar.

Ejemplo:

"Serasa KYC"

status

enum<string>

Estado actual del ciclo de vida: unconfigured, configured, tested, active o disabled.

Opciones disponibles:

unconfigured,

configured,

tested,

active,

disabled

Ejemplo:

"active"

updatedAt

string<date-time>

Marca de tiempo de la última actualización.

Ejemplo:

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

Obtener una configuración de ejecutor

Eliminar una configuración de ejecutor

⌘I

Primeros pasos

API de Catálogo

API de Workflows

API de Ejecuciones

API de Dashboards

API de Configuraciones de Executor

API de Configuraciones de Provider

API de Auditoría

API de Webhooks

Manejo de errores

Actualizar una configuración de ejecutor

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta