Pular para o conteúdo principal

Configurações

Gerenciamento de configurações de decisão (Platform Configs) que orquestram o Decision Engine com fontes de dados.

Endpoints

MétodoEndpointDescriçãoPermissão
POST/api/v1/decision-platform/configsCriar configuraçãoDECISION_VERSIONS_CREATE
GET/api/v1/decision-platform/configsListar configuraçõesDECISION_VERSIONS_READ
GET/api/v1/decision-platform/configs/:idObter configuraçãoDECISION_VERSIONS_READ
GET/api/v1/decision-platform/configs/:id/fullObter com relaçõesDECISION_VERSIONS_READ
PATCH/api/v1/decision-platform/configs/:idAtualizar configuraçãoDECISION_VERSIONS_CREATE
DELETE/api/v1/decision-platform/configs/:idExcluir configuraçãoDECISION_PROJECTS_DELETE
POST/api/v1/decision-platform/configs/:id/publishPublicar configuraçãoDECISION_VERSIONS_CREATE

Atributos

CampoTipoDescrição
decisionIdstring (UUID)ID da decisão no Decision Engine
namestringNome da configuração
keystringChave única (lowercase, hyphens)
descriptionstringDescrição opcional
statusenumStatus: DRAFT, PUBLISHED, ARCHIVED
defaultTimeoutMsnumberTimeout padrão (1000-300000ms)
maxTimeoutMsnumberTimeout máximo permitido
callbackUrlstringURL para callbacks assíncronos
callbackHeadersobjectHeaders para callbacks
createdAtdatetimeData de criação
updatedAtdatetimeData da última atualização

Status da Configuração

StatusDescrição
DRAFTRascunho, pode ser editada
PUBLISHEDPublicada, disponível para execução
ARCHIVEDArquivada, não pode ser executada

Criar Configuração

POST /api/v1/decision-platform/configs

Cria uma nova configuração de decisão.

Atributos

CampoTipoObrigatórioDescrição
decisionIdstringSimID da decisão no Decision Engine
namestringSimNome da configuração
keystringSimChave única (ex: credit-analysis)
descriptionstringNãoDescrição
defaultTimeoutMsnumberNãoTimeout padrão (default: 30000)
maxTimeoutMsnumberNãoTimeout máximo (default: 30000)
callbackUrlstringNãoURL para callbacks assíncronos
callbackHeadersobjectNãoHeaders para callbacks
curl -X POST 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/configs' \
-H 'Authorization: Bearer SEU_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"type": "platform-configs",
"attributes": {
"decisionId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Análise de Crédito",
"key": "credit-analysis",
"description": "Configuração para análise de crédito de pessoas físicas",
"defaultTimeoutMs": 30000,
"callbackUrl": "https://api.empresa.com/webhooks/decisions"
}
}
}'

Response (201 Created)

{
"data": {
"type": "platform-configs",
"id": "550e8400-e29b-41d4-a716-446655440001",
"links": {
"self": "/api/v1/decision-platform/configs/550e8400-e29b-41d4-a716-446655440001"
},
"attributes": {
"decisionId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Análise de Crédito",
"key": "credit-analysis",
"description": "Configuração para análise de crédito de pessoas físicas",
"status": "DRAFT",
"defaultTimeoutMs": 30000,
"maxTimeoutMs": 30000,
"callbackUrl": "https://api.empresa.com/webhooks/decisions",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"links": {
"self": "/api/v1/decision-platform/configs/550e8400-e29b-41d4-a716-446655440001"
}
}

Listar Configurações

GET /api/v1/decision-platform/configs

Lista todas as configurações com suporte a paginação e filtros.

Query Parameters

ParâmetroTipoDescrição
page[number]integerNúmero da página
page[size]integerItens por página
filter[status]enumFiltrar por status
filter[decisionId]UUIDFiltrar por decisão
curl 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/configs?filter[status]=PUBLISHED' \
-H 'Authorization: Bearer SEU_TOKEN'

Obter Configuração com Relações

GET /api/v1/decision-platform/configs/:id/full

Obtém uma configuração com suas versões e data sources.

curl 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/configs/550e8400-e29b-41d4-a716-446655440001/full' \
-H 'Authorization: Bearer SEU_TOKEN'

Response (200 OK)

{
"data": {
"type": "platform-configs",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"name": "Análise de Crédito",
"key": "credit-analysis",
"status": "PUBLISHED"
},
"relationships": {
"versions": {
"data": [
{
"type": "platform-versions",
"id": "550e8400-e29b-41d4-a716-446655440010",
"attributes": {
"version": "1.0.0",
"status": "PUBLISHED"
}
}
]
},
"dataSources": {
"data": [
{
"type": "platform-data-sources",
"id": "550e8400-e29b-41d4-a716-446655440020",
"attributes": {
"name": "Consulta Serasa",
"type": "HTTP"
}
}
]
}
}
}
}

Publicar Configuração

POST /api/v1/decision-platform/configs/:id/publish

Publica uma configuração, tornando-a disponível para execução.

curl -X POST 'https://decision-platform.stg.catalisa.app/api/v1/decision-platform/configs/550e8400-e29b-41d4-a716-446655440001/publish' \
-H 'Authorization: Bearer SEU_TOKEN'

Erros Comuns

CódigoErroDescrição
400VALIDATIONDados inválidos (key inválida, timeout fora do range)
404NOT_FOUNDConfiguração ou decisão não encontrada
409CONFLICTKey já existe na organização
409CONFLICTConfiguração não está em DRAFT (para publicar)