Skip to content

@fc/backoffice ​

O backoffice mantém as tabelas de referência e o catálogo usados pelas calculadoras da Fábrica de Cálculos. Também oferece um painel administrativo autenticado. Esta página descreve apenas a superfície pública para integração; as operações administrativas e a persistência são tratadas na documentação interna do projeto.

APIs públicas ​

O contrato publicado está em /_openapi.json e no portal Swagger unificado da Fábrica de Cálculos. As consultas de índices não exigem autenticação. As operações que exigem chave indicam isso no OpenAPI.

Índices (/indices/api/v1/) ​

EndpointResultado
GET /indices/api/v1/tabelaIndexadores e taxas por competência. Aceita competenciaInicial, competenciaFinal e indice[].
GET /indices/api/v1/tabela/{competencia}Indexadores de uma competência YYYY-MM.
GET /indices/api/v1/reajusteReajuste de benefícios previdenciários, com filtros opcionais por competência.
GET /indices/api/v1/reajuste-pre-realReajuste de benefícios anterior ao Real.
GET /indices/api/v1/adiantamentoAdiantamento de abono anual.
GET /indices/api/v1/limitesPiso e teto do RGPS por competência, com fonte normativa e filtros opcionais por competência.
GET /indices/api/v1/limite-baixa-renda-reclusaoLimite de renda para auxílio-reclusão, vigência e fundamento, com filtros opcionais por competência.
GET /indices/api/v1/moedasMoedas do período anterior ao Real.
GET /indices/api/v1/os121Reajuste da OS 121.
GET /indices/api/v1/tabua-mortalidadeTábuas de mortalidade do IBGE.

As competências de indexadores seguem YYYY-MM. Filtros com intervalo invertido são recusados com HTTP 400. As séries de piso, teto e baixa renda são atualizadas pelo serviço e consumidas pelas calculadoras; dado ausente em uma competência necessária deve ser tratado como indisponibilidade, sem inventar um valor.

Apps (/apps/api/v1/) ​

EndpointAutenticaçãoResultado
GET /apps/api/v1/calculadorasNenhumaCatálogo público das calculadoras ativas, com nome canônico, ID e URL do ambiente.
POST /apps/api/v1/exchangeChave de APIToken de uso único e URL para abrir uma calculadora com dados pré-preenchidos, conforme o schema OpenAPI.

O catálogo lista apenas apps ativas da categoria calculadora. Utilidades que aparecem no portal, mas pertencem a outra categoria, não são listadas por esse endpoint. Aliases antigos servem à leitura de dados legados e não substituem o nome canônico apresentado ao usuário.

O exchange aceita dados básicos do processo e blocos documentais estruturados, incluindo RDCTC, CNIS e PrevJud, segundo o schema publicado. A resposta contém o token, sua expiração e a URL de abertura. Configure a chave no cabeçalho HTTP do cliente; não a inclua em URL, arquivo versionado ou exemplo preenchido.

Formato das respostas ​

Respostas de sucesso usam um envelope com status, code, messages e result:

json
{ "status": "ok", "code": "200", "messages": [], "result": {} }

Listagens paginadas acrescentam page-info, com página atual, última página, tamanho e contagem. A paginação usa o parâmetro page=size:N,page:N. Erros HTTP usam o formato nativo de erro do Nitro/H3; consulte o código de status e a mensagem do endpoint no OpenAPI. Filtros inválidos retornam HTTP 400.

Painel e atualização dos dados ​

O painel administrativo autenticado permite consultar e manter tabelas de referência, conforme as permissões do operador. As alterações são auditadas. Além da edição manual, as séries que têm fonte externa podem ser atualizadas pelo serviço; uma atualização automática preserva os valores preenchidos manualmente.

A API pública mostra a série efetivamente publicada. Antes de usar piso, teto ou baixa renda em um cálculo, confira competência, valor e fundamento retornados.

Desenvolvimento ​

bash
pnpm --filter @fc/backoffice dev
pnpm --filter @fc/backoffice test:run
pnpm --filter @fc/backoffice spec:gen

Comandos de banco, migrations, configuração de sessão, operações do painel, rotas privadas, jobs e critérios de auditoria ficam na documentação interna do contexto.