Atualizar uma configuração de provider

curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowedHosts": [
    "api.acme.com",
    ".kyc-provider.io"
  ],
  "allowedPrivateHosts": [
    "nginx.pix-inline.internal"
  ],
  "config": {},
  "description": "ClearSale anti-fraud — updated with new API version",
  "metadata": {},
  "name": "ClearSale Production v2",
  "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/{id}"

payload = {
    "allowedHosts": ["api.acme.com", ".kyc-provider.io"],
    "allowedPrivateHosts": ["nginx.pix-inline.internal"],
    "config": {},
    "description": "ClearSale anti-fraud — updated with new API version",
    "metadata": {},
    "name": "ClearSale Production v2",
    "schemaBindings": [
        {
            "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
            "type": "openapi",
            "operations": [
                {
                    "method": "POST",
                    "path": "/payments"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowedHosts: ['api.acme.com', '.kyc-provider.io'],
    allowedPrivateHosts: ['nginx.pix-inline.internal'],
    config: {},
    description: 'ClearSale anti-fraud — updated with new API version',
    metadata: {},
    name: 'ClearSale Production v2',
    schemaBindings: [
      {
        schemaId: '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
        type: 'openapi',
        operations: [{method: 'POST', path: '/payments'}]
      }
    ]
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/provider-configurations/{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/provider-configurations/{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([
    'allowedHosts' => [
        'api.acme.com',
        '.kyc-provider.io'
    ],
    'allowedPrivateHosts' => [
        'nginx.pix-inline.internal'
    ],
    'config' => [
        
    ],
    'description' => 'ClearSale anti-fraud — updated with new API version',
    'metadata' => [
        
    ],
    'name' => 'ClearSale Production v2',
    '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/{id}"

	payload := strings.NewReader("{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\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("PATCH", 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.patch("https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\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/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\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

{
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "description": "ClearSale anti-fraud for Pix transactions",
  "providerId": "clearsale",
  "kind": "catalog",
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "environment": "production"
  },
  "allowedHosts": [
    "api.clearsale.com.br"
  ],
  "schemaBindings": [],
  "status": "active",
  "metadata": {
    "team": "risk"
  },
  "createdAt": "2026-03-17T14:00:00Z",
  "updatedAt": "2026-03-17T14:00:00Z"
}

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

PATCH

provider-configurations

{id}

Atualizar uma configuração de provider

curl --request PATCH \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowedHosts": [
    "api.acme.com",
    ".kyc-provider.io"
  ],
  "allowedPrivateHosts": [
    "nginx.pix-inline.internal"
  ],
  "config": {},
  "description": "ClearSale anti-fraud — updated with new API version",
  "metadata": {},
  "name": "ClearSale Production v2",
  "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/{id}"

payload = {
    "allowedHosts": ["api.acme.com", ".kyc-provider.io"],
    "allowedPrivateHosts": ["nginx.pix-inline.internal"],
    "config": {},
    "description": "ClearSale anti-fraud — updated with new API version",
    "metadata": {},
    "name": "ClearSale Production v2",
    "schemaBindings": [
        {
            "schemaId": "018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8",
            "type": "openapi",
            "operations": [
                {
                    "method": "POST",
                    "path": "/payments"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    allowedHosts: ['api.acme.com', '.kyc-provider.io'],
    allowedPrivateHosts: ['nginx.pix-inline.internal'],
    config: {},
    description: 'ClearSale anti-fraud — updated with new API version',
    metadata: {},
    name: 'ClearSale Production v2',
    schemaBindings: [
      {
        schemaId: '018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8',
        type: 'openapi',
        operations: [{method: 'POST', path: '/payments'}]
      }
    ]
  })
};

fetch('https://flowker.sandbox.lerian.net/v1/provider-configurations/{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/provider-configurations/{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([
    'allowedHosts' => [
        'api.acme.com',
        '.kyc-provider.io'
    ],
    'allowedPrivateHosts' => [
        'nginx.pix-inline.internal'
    ],
    'config' => [
        
    ],
    'description' => 'ClearSale anti-fraud — updated with new API version',
    'metadata' => [
        
    ],
    'name' => 'ClearSale Production v2',
    '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/{id}"

	payload := strings.NewReader("{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\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("PATCH", 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.patch("https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\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/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowedHosts\": [\n    \"api.acme.com\",\n    \".kyc-provider.io\"\n  ],\n  \"allowedPrivateHosts\": [\n    \"nginx.pix-inline.internal\"\n  ],\n  \"config\": {},\n  \"description\": \"ClearSale anti-fraud — updated with new API version\",\n  \"metadata\": {},\n  \"name\": \"ClearSale Production v2\",\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

{
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "description": "ClearSale anti-fraud for Pix transactions",
  "providerId": "clearsale",
  "kind": "catalog",
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "environment": "production"
  },
  "allowedHosts": [
    "api.clearsale.com.br"
  ],
  "schemaBindings": [],
  "status": "active",
  "metadata": {
    "team": "risk"
  },
  "createdAt": "2026-03-17T14:00:00Z",
  "updatedAt": "2026-03-17T14:00:00Z"
}

{
  "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>.

Parâmetros de caminho

string<uuid>

obrigatório

Identificador único da configuração de provider.

Corpo

application/json

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

allowedHosts

string[]

Substitui a lista de hosts permitidos. Omita o campo para manter a lista armazenada sem alteração. Envie uma lista vazia para limpá-la, e uma lista não vazia para substituí-la. A lista nova precisa cumprir as mesmas regras da criação, incluindo a verificação de cobertura da URL base e a regra do provider HTTP genérico.

Maximum array length: 100

Maximum string length: 253

Exemplo:

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

allowedPrivateHosts

string[]

Substitui o conjunto de hosts privados permitidos. Omita o campo para manter o conjunto armazenado sem alteração. Envie uma lista vazia para limpá-lo, e uma lista não vazia para substituí-lo. As entradas seguem o mesmo formato da criação.

Maximum array length: 100

Maximum string length: 253

Exemplo:

["nginx.pix-inline.internal"]

config

object

Configuração específica do provider atualizada.

Show child attributes

description

string

Descrição atualizada.

Maximum string length: 500

Exemplo:

"ClearSale anti-fraud — updated with new API version"

metadata

object

Metadados atualizados.

Show child attributes

name

string

Nome atualizado.

Required string length: 1 - 100

Exemplo:

"ClearSale Production v2"

schemaBindings

object[]

Substitui os vínculos com schemas. Omita o campo para manter os vínculos armazenados sem alteração. Envie uma lista vazia para remover todos, e uma lista não vazia para substituir o conjunto. O Flowker verifica cada entrada contra os schemas armazenados antes de salvar qualquer coisa.

Maximum array length: 100

Show child attributes

Resposta

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

config

object

obrigatório

Configuração específica do provider.

Show child attributes

Exemplo:

{
  "baseUrl": "https://api.clearsale.com.br",
  "environment": "production"
}

createdAt

string<date-time>

obrigatório

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

Exemplo:

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

string<uuid>

obrigatório

Identificador único da configuração.

Exemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

kind

enum<string>

obrigatório

Tipo de conexão desta configuração: catalog aponta para um provider publicado no catálogo, e external_openapi aponta para um documento OpenAPI registrado no seu tenant.

Opções disponíveis:

catalog,

external_openapi

Exemplo:

"catalog"

name

string

obrigatório

Nome da configuração.

Exemplo:

"ClearSale Production"

providerId

string

obrigatório

ID do provider do catálogo para o qual esta configuração aponta. Uma configuração de kind external_openapi criada sem um carrega no lugar o id reservado external.openapi.

Exemplo:

"clearsale"

schemaBindings

object[]

obrigatório

Schemas armazenados aos quais esta configuração se vincula. O campo sempre aparece, e é uma lista vazia quando a configuração não vincula nenhum schema.

Show child attributes

status

enum<string>

obrigatório

Status atual: active ou disabled.

Opções disponíveis:

active,

disabled

Exemplo:

"active"

updatedAt

string<date-time>

obrigatório

Marca temporal da última atualização.

Exemplo:

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

allowedHosts

string[]

Lista de hosts de destino permitidos para as chamadas de saída. O campo não aparece quando a configuração não declara nenhuma lista.

Maximum array length: 100

Maximum string length: 253

Exemplo:

["api.clearsale.com.br"]

allowedPrivateHosts

string[]

Hosts privados nomeados que esta configuração pode alcançar, gerenciados pela sua equipe de operações. O campo não aparece quando o conjunto está vazio.

Maximum array length: 100

Maximum string length: 253

Exemplo:

["nginx.pix-inline.internal"]

description

string

Descrição legível por humanos.

Exemplo:

"ClearSale anti-fraud for Pix transactions"

metadata

object

Metadados personalizados.

Show child attributes

Exemplo:

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

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

Atualizar uma configuração de provider

Autorizações

Parâmetros de caminho

Corpo

Resposta