Skip to main content
POST
Criar uma configuração de provedor

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.

Corpo

application/json

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

config
object
obrigatório

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

Exemplo:
name
string
obrigatório

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

Required string length: 1 - 100
Exemplo:

"ClearSale Production"

providerId
string
obrigatório

ID do provedor do catálogo a ser configurado. Deve corresponder a um provedor registrado.

Exemplo:

"clearsale"

description
string

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

Maximum string length: 500
Exemplo:

"ClearSale anti-fraud for Pix transactions"

metadata
object

Pares chave-valor personalizados para etiquetagem.

Exemplo:

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"

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