Catalisa.Building Blocks
Catálogo/Bureaus/API

API do Bureaus

15 endpoints em 3 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 →

15 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 credencialBUREAUS_ADMIN
  • GET/bureaus/api/v1/providersListaBUREAUS_READ
  • GET/bureaus/api/v1/providers/:idDetalheBUREAUS_READ
  • PATCH/bureaus/api/v1/providers/:idAtualizaBUREAUS_ADMIN
  • DELETE/bureaus/api/v1/providers/:idRemoveBUREAUS_ADMIN
  • POST/bureaus/api/v1/providers/:id/test-connectionTesta a credencialBUREAUS_ADMIN

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