Catalisa.Building Blocks

API do Bureaus

18 endpoints em 4 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

16 endpoints

Consultas

/bureaus/api/v1/queries4
  • POST/bureaus/api/v1/queriesConsulta síncronaBUREAUS_QUERY
  • POST/bureaus/api/v1/queries/batchLote, resultado item a itemBUREAUS_QUERY
  • GET/bureaus/api/v1/queriesA trilhaBUREAUS_READ
  • GET/bureaus/api/v1/queries/:idResultado, canônico e brutoBUREAUS_READ

Fornecedores

/bureaus/api/v1/providers6
  • POST/bureaus/api/v1/providersCadastra e valida a credencial. 403 SIMULATED_PROVIDER_NOT_GRANTED em produção para providerType: MOCK em organização sem concessão e fora da variável de reserva (§13). 400 PROVIDER_BASE_URL_NOT_ALLOWED em produção para settings.baseUrl fora da lista de hosts do fornecedor (§13)BUREAUS_ADMIN
  • GET/bureaus/api/v1/providersListaBUREAUS_READ
  • GET/bureaus/api/v1/providers/:idDetalheBUREAUS_READ
  • PATCH/bureaus/api/v1/providers/:idAtualiza. **Ativar** (isActive: true) ou **tornar padrão** (isDefault: true) uma configuração MOCK recusa igual à criação. 400 PROVIDER_BASE_URL_NOT_ALLOWED em produção se o settings enviado — ou o já gravado, numa configuração que fica ativa — tem baseUrl fora da lista de hostsBUREAUS_ADMIN
  • DELETE/bureaus/api/v1/providers/:idRemoveBUREAUS_ADMIN
  • POST/bureaus/api/v1/providers/:id/test-connectionTesta a credencial. 403 PROVIDER_BASE_URL_NOT_ALLOWED em produção se a configuração aponta para host fora da lista (nenhuma chamada é feita)BUREAUS_ADMIN

Operador da plataforma

/bureaus/api/v1/admin/platform/organizations1
  • GET/bureaus/api/v1/admin/platform/organizations/:organizationId/simulated-providerO estado: granted (há concessão ativa), allowedByEnvironment (a variável ou o ambiente já liberam) e allowed (o veredito de agora)operador da plataforma

Catálogo, consumo e manutenção

/bureaus/api/v15
  • GET/bureaus/api/v1/catalogO que dá para perguntar e a que TTLBUREAUS_READ
  • GET/bureaus/api/v1/usageConsumo, custo e taxa de acertoBUREAUS_READ
  • POST/bureaus/api/v1/cache/invalidateInvalida por kind ou por documentoBUREAUS_ADMIN
  • POST/bureaus/api/v1/retention/purge-payloadsApaga o dado pessoal, preserva a trilhaBUREAUS_ADMIN
  • POST/bureaus/api/v1/retention/cleanup-cacheRemove entradas vencidasBUREAUS_ADMIN