Skip to main content
POST
Habilitar uma configuração de provider

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

id
string<uuid>
obrigatório

Identificador único da configuração de provider.

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.

Exemplo:
createdAt
string<date-time>
obrigatório

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

Exemplo:

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

id
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.

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:
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:
description
string

Descrição legível por humanos.

Exemplo:

"ClearSale anti-fraud for Pix transactions"

metadata
object

Metadados personalizados.

Exemplo: