Pular para o conteúdo principal

APIs externas (proxies autenticados)

Módulo: ExternalApisModule
Auth: Bearer em todas
Tag: APIs externas

Catálogo: catalogo-completo.md §12.

O CentralCRM faz proxy autenticado para serviços públicos externos.

MétodoRota CentralCRMUpstream
GET/api/v1/external-apis/opencnpj/:cnpjhttps://api.opencnpj.org/{CNPJ}
GET/api/v1/external-apis/cep/v1/:cephttps://brasilapi.com.br/api/cep/v1/{cep}
GET/api/v1/external-apis/cep/v2/:cephttps://brasilapi.com.br/api/cep/v2/{cep}
GET/api/v1/external-apis/banks/v1https://brasilapi.com.br/api/banks/v1

Controllers

ControllerPath
OpencnpjV1Controllerexternal-apis/opencnpj
BrasilApiCepV1Controllerexternal-apis/cep
BrasilApiBanksV1Controllerexternal-apis/banks

Notas

  • OpenCNPJ: CNPJ sem máscara (apenas dígitos) no path.
  • CEP v2: inclui geolocalização quando disponível.
  • Banks: lista de bancos brasileiros.
  • Erros do upstream são mapeados para HTTP adequado (4xx/5xx) pelo serviço Nest.