Pular para o conteúdo

Calibração

Seções da Calibração. As seções da Calibração da empresa (Forecast, Perfil de cliente, Motivos de perda e as que vierem): o que cada uma decide, se foi mudada do padrão e a última mudança, com quem fez e por onde (app, api, mcp). Só administradores.

Operação calibration.sections — a mesma de GET /v1/calibration
Escopo context:read
Papéis admin
Classe de limite read
Auditada não
Comportamento somente leitura · idempotente

Entrada

Nenhum argumento.

Resultado

O JSON da resposta de sucesso de GET /v1/calibration, com os mesmos campos.

Uma seção da Calibração. Os valores em vigor de uma seção, os padrões, o JSON Schema da mudança que ela aceita (changesSchema), o que a tela mostra além dos valores (funis e etapas, faixas dos limites, regras fixas) e as últimas mudanças. Leia antes de propor uma mudança. Só administradores.

Operação calibration.get — a mesma de GET /v1/calibration/{section}
Escopo context:read
Papéis admin
Classe de limite read
Auditada não
Comportamento somente leitura · idempotente

Entrada

Campo Tipo Obrigatório Descrição
section string sim Seção da Calibração: forecast, customer-profile, losses, risk-reading ou crm-fill (a lista completa vem de GET /v1/calibration) (mín. 1 caractere; máx. 64 caracteres)

Resultado

O JSON da resposta de sucesso de GET /v1/calibration/{section}, com os mesmos campos.

Prévia de uma mudança da Calibração. Primeiro passo de toda mudança: o antes e o depois, o que mudaria e o efeito como a tela mostra (por exemplo quantos negócios abertos passariam a pedir a declaração, ou quantos commits ficariam em dúvida), sem gravar nada. Com reset: true, a prévia da volta da seção ao padrão. Devolve confirmation.token para calibration_apply (ou calibration_reset). Nunca aplique sem a pessoa ter visto a prévia e dito sim nesta conversa: mostre o antes, o depois e os efeitos, pergunte, e só então chame com o confirmation.token. O token vale 10 minutos, só para aquela mudança, e cai se alguém mudar a seção antes. Exige o escopo calibration:write.

Operação calibration.preview — a mesma de POST /v1/calibration/{section}/preview
Escopo calibration:write
Papéis admin
Classe de limite read
Auditada não
Comportamento somente leitura · idempotente

Entrada

Campo Tipo Obrigatório Descrição
section string sim Seção da Calibração: forecast, customer-profile, losses, risk-reading ou crm-fill (a lista completa vem de GET /v1/calibration) (mín. 1 caractere; máx. 64 caracteres)
changes object não A mudança da seção, no formato de changesSchema em GET /v1/calibration/{section}: só os grupos ou limites enviados mudam, os outros ficam como estão
reset boolean não true para a prévia da volta de toda a seção ao padrão, no lugar de changes

Resultado

O JSON da resposta de sucesso de POST /v1/calibration/{section}/preview, com os mesmos campos.

Aplicar uma mudança da Calibração. Segundo passo: grava a mudança que calibration_preview mostrou, com exatamente as mesmas changes e o confirmation.token dela. Nunca aplique sem a pessoa ter visto a prévia e dito sim nesta conversa: mostre o antes, o depois e os efeitos, pergunte, e só então chame com o confirmation.token. O token vale 10 minutos, só para aquela mudança, e cai se alguém mudar a seção antes. A mudança entra no histórico da seção como feita pelo MCP e na atividade da API. Exige o escopo calibration:write.

Operação calibration.update — a mesma de PUT /v1/calibration/{section}
Escopo calibration:write
Papéis admin
Classe de limite write
Auditada sim
Comportamento escreve · idempotente · destrutiva: o cliente deve pedir confirmação

Entrada

Campo Tipo Obrigatório Descrição
section string sim Seção da Calibração: forecast, customer-profile, losses, risk-reading ou crm-fill (a lista completa vem de GET /v1/calibration) (mín. 1 caractere; máx. 64 caracteres)
changes object sim Exatamente a mesma mudança enviada a calibration_preview
confirmationToken string sim O confirmation.token que a prévia desta mesma mudança devolveu; vale 10 minutos (mín. 1 caractere; máx. 4096 caracteres)

Resultado

O mesmo JSON de PUT /v1/calibration/{section}: a seção com a mudança aplicada. Diferente da rota, só aplica com o confirmationToken devolvido por calibration_preview para esta mudança.

Voltar uma seção da Calibração ao padrão. Volta a seção inteira aos padrões do Nexo, com o confirmation.token de calibration_preview com reset: true. Nunca aplique sem a pessoa ter visto a prévia e dito sim nesta conversa: mostre o antes, o depois e os efeitos, pergunte, e só então chame com o confirmation.token. O token vale 10 minutos, só para aquela mudança, e cai se alguém mudar a seção antes. Exige o escopo calibration:write.

Operação calibration.reset — a mesma de POST /v1/calibration/{section}/reset
Escopo calibration:write
Papéis admin
Classe de limite write
Auditada sim
Comportamento escreve · idempotente · destrutiva: o cliente deve pedir confirmação

Entrada

Campo Tipo Obrigatório Descrição
section string sim Seção da Calibração: forecast, customer-profile, losses, risk-reading ou crm-fill (a lista completa vem de GET /v1/calibration) (mín. 1 caractere; máx. 64 caracteres)
confirmationToken string sim O confirmation.token que calibration_preview com reset: true devolveu (mín. 1 caractere; máx. 4096 caracteres)

Resultado

O mesmo JSON de POST /v1/calibration/{section}/reset: a seção de volta ao padrão. Diferente da rota, só aplica com o confirmationToken devolvido por calibration_preview (com reset: true).