Referência da API

Executar, consultar, versionar.

A API é REST com JSON. Os caminhos abaixo são relativos ao endereço da API informado na sua conta; a autenticação é a chave do ambiente, num cabeçalho.

Autenticação

Uma chave por ambiente

X-API-Key
A chave gerada no console. Cada chave é de teste ou de produção e tem validade.
Teste
Ilimitada, nunca cobra e não enxerga dado de produção.
Idempotency-Key
Opcional na execução. A mesma chave em 24 horas devolve a mesma decisão; a mesma chave com outra entrada responde 409.
Executar

Rodar a esteira ou só a política

POST /decision-platform/api/v1/execute
Roda a esteira publicada: busca as fontes, executa a política e devolve o resultado com o trace. Síncrono, numa chamada.
GET /decision-platform/api/v1/executions/:id
A execução guardada: entradas, saída, tempos e versão.
GET /decision-platform/api/v1/executions
A lista de execuções, para conciliar e auditar.
POST /decision-engine/api/v1/decisions/:id/execute
Só a política, sem esteira: você manda a entrada completa e recebe a decisão da última versão publicada.
Políticas e versões

O ciclo de vida, pela API

POST /decision-engine/api/v1/decisions/:id/versions
Cria uma versão a partir do XML DMN. O motor valida antes de salvar.
GET /decision-engine/api/v1/versions/:id
A versão com o XML DMN inteiro — é assim que a política sai.
POST /decision-engine/api/v1/versions/:id/publish
Põe a versão no ar. A próxima execução já usa ela.
POST /decision-engine/api/v1/versions/:id/archive
Tira a versão do ar; a anterior publicada volta a valer.
GET /decision-engine/api/v1/execution-logs
O registro de cada execução da política, com o trace.
Erros

Código estável, mensagem legível

402 QUOTA_EXCEEDED
A franquia do mês acabou (o mês segue o calendário de São Paulo). A resposta diz quanto foi usado.
403 SUBACCOUNT_SUSPENDED
A subconta que chamou está suspensa.
409
A mesma Idempotency-Key foi usada com uma entrada diferente.

Faça a primeira chamada com a chave de teste