API Pública Banqer CRM

A API Pública é o canal oficial para que seu sistema leia dados do Banqer CRM: saldo de fichas, contratos, acordos, parcelas, pagamentos, identidade e contatos do titular. Cobre os cenários comuns de chatbot de negociação, motor de propostas, painel de BI e aplicativo do cliente final.

A mesma especificação é exposta em dois protocolos:

• REST sobre HTTPS (recomendado para a maioria das integrações).
• gRPC sobre HTTP/2 (para integrações que já usam stubs gerados a partir do .proto).

Esta documentação foca em REST. Os exemplos de código cobrem curl, Python, JavaScript (Node), Java, C# e Go.

Antes de começar

Você precisa de três informações fornecidas pelo seu gestor Banqer:

Variável	O que é	Exemplo
SUA-EMPRESA	Subdomínio do seu deployment Banqer	acme
SEU_CLIENT_ID	Identificador da credencial do integrador	partner-acme
SEU_CLIENT_SECRET	Segredo da credencial	(string longa, entregue uma única vez)

Cada cliente Banqer tem seu próprio subdomínio. A URL base da sua API é:

https://api-SUA-EMPRESA.banqer.com.br/

E o endpoint de autenticação do seu deployment é:

https://auth.banqer.com.br/realms/SUA-EMPRESA/protocol/openid-connect/token

Não tem credenciais ainda?

Entre em contato com seu gestor Banqer. A emissão é feita pela operação Banqer com base em um termo de uso que define quais permissões e produtos ficam visíveis para você.

Primeira chamada (cURL)

A primeira chamada que valida tudo funcionando é o ping, que não requer autenticação:

curl https://api-SUA-EMPRESA.banqer.com.br/v1/ping?message=ola

Resposta:

{ "message": "ola", "serverTime": "2026-05-28T03:12:53Z" }

Para uma chamada real, você obtém um token e o envia no header Authorization:

# 1. Obter token (validade: 5 minutos)
TOKEN=$(curl -s -X POST \
  "https://auth.banqer.com.br/realms/SUA-EMPRESA/protocol/openid-connect/token" \
  -d "grant_type=client_credentials" \
  -d "client_id=SEU_CLIENT_ID" \
  -d "client_secret=SEU_CLIENT_SECRET" \
  | python -c "import sys,json; print(json.load(sys.stdin)['access_token'])")

# 2. Usar o token
curl -H "Authorization: Bearer $TOKEN" \
  "https://api-SUA-EMPRESA.banqer.com.br/v1/credores"

Resposta esperada: a lista de credores aos quais sua credencial tem acesso.

Por onde seguir

1. Autenticação: como pegar o token, fazer cache em memória e renovar quando expirar.
2. Escopos e permissões: catálogo dos cinco escopos disponíveis e como identificar o requisito de cada endpoint.
3. Pontos de atenção: paginação, formato de erros, headers e limites de uso.
4. Exemplos por linguagem: copy-paste pronto para a sua stack.
5. Receitas: cenários completos resolvidos.
6. Referência da API: todos os endpoints e schemas.

Estabilidade do contrato

A versão atual é a V1. Novos endpoints e novos campos opcionais podem ser adicionados sem aviso prévio. Mudanças que quebrariam clientes existentes (renomear ou remover campos) entram em uma V2 publicada em paralelo. O header Banqer-API-Version em toda resposta carrega a versão semver atual: use para detecção de capacidades novas em integrações de longa vida.