Antes de usar os endpoints da Referência da API, vale entender as convenções comuns a todos os módulos do External (a API do parceiro).

​
Autenticação e ambientes

A API usa token Bearer (OAuth2 client credentials): você autentica em {base}/Auth/External/Authenticate com client_id / client_secret / tenant_code e envia o access_token recebido no header Authorization: Bearer <token> em cada chamada. Tudo é restrito ao seu tenant. Bases por ambiente — Sandbox: https://api.sistemahubcred.dev/external/v1 · Produção: https://gateway.hubcred.com.br/external/v1. Os endpoints seguem {base}/api/services/app/<Módulo>/<Ação>.
Passo a passo, exemplos (curl) e expiração do token em Autenticação.

​
Envelope de resposta

As respostas vêm no envelope padrão da plataforma. O objeto documentado em cada endpoint (na Referência da API) é o conteúdo de result; success indica sucesso e, em erro, a mensagem vem em error.
Sucesso
Erro
​
result
object | array | null
O objeto documentado no endpoint (o schema de resposta que aparece na Referência da API). null em caso de erro.
​
success
boolean
true quando a operação foi bem-sucedida.
​
error
object | null
Presente quando success é false. Contém message (PT-BR) com a descrição do erro.
Na Referência da API, o schema de resposta mostra o objeto de result (o DTO). Em runtime, ele chega dentro do envelope acima — sempre cheque success antes de consumir result.

​
Erros

Erros de negócio (ex.: operação não encontrada, dados inválidos) retornam success: false com uma mensagem legível em error.message (PT-BR). Sempre verifique success antes de consumir result.

​
Código da operação (Operation.Code)

Toda operação é identificada publicamente por um código string (code), gerado pela HubCred — nunca pelo id interno. É esse code que você usa nos endpoints de Operações (detalhes, eventos, CCB, cancelar) e que recebe também no webhook de status.

​
Produtos e status (legenda)

Os campos product e status são numéricos. Produtos: A legenda completa de status (0–103) está na página do webhook de mudança de status — é a mesma usada aqui.

​
Listagem de operações

Use GET /Operacoes/Listar como a listagem transversal canônica (todos os produtos, filtrável por produto/status/período).
O endpoint GET /EmprestimoFgts/ListarOperacoes está deprecado — use Operacoes/Listar no lugar. Ele continua funcionando por compatibilidade, mas será removido em uma mudança coordenada.