Saltar al contenido principal
POST
/
v1
/
provider-configurations
Crear una configuración de proveedor
curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config": {
    "baseUrl": "https://api.clearsale.com.br",
    "apiKey": "cs-key-abc123",
    "environment": "production"
  },
  "name": "ClearSale Production",
  "providerId": "clearsale",
  "description": "ClearSale anti-fraud for Pix transactions",
  "metadata": {
    "environment": "production",
    "team": "risk"
  }
}
'
{
  "createdAt": "2026-03-17T14:00:00Z",
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "name": "ClearSale Production",
  "status": "active"
}

Autorizaciones

​
X-API-Key
string
header
requerido

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Cuerpo

application/json

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

​
config
object
requerido

Configuración específica del proveedor que se valida contra el JSON Schema del proveedor.

Ejemplo:
{
  "baseUrl": "https://api.clearsale.com.br",
  "apiKey": "cs-key-abc123",
  "environment": "production"
}
​
name
string
requerido

Nombre único para esta configuración de proveedor.

Required string length: 1 - 100
Ejemplo:

"ClearSale Production"

​
providerId
string
requerido

ID del proveedor del catálogo a configurar. Debe coincidir con un proveedor registrado.

Ejemplo:

"clearsale"

​
description
string

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

Maximum string length: 500
Ejemplo:

"ClearSale anti-fraud for Pix transactions"

​
metadata
object

Pares clave-valor personalizados para etiquetado.

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

Respuesta

Indica que el recurso fue creado exitosamente y la operación se completó según lo esperado.

​
createdAt
string<date-time>

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

Ejemplo:

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

​
id
string<uuid>

Identificador único de la configuración creada.

Ejemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

​
name
string

Nombre de la configuración.

Ejemplo:

"ClearSale Production"

​
status
string

Estado inicial (siempre active al crear).

Ejemplo:

"active"