Objetivo: Permitir que o ZP Cobrança se conecte à API de Boletos do Banco do Brasil para automatizar a emissão, gestão, e consulta de boletos bancários, utilizando credenciais de API e o número do convênio bancário.
| Parâmetros | Descrição |
|---|---|
| client_id | Client ID |
| client_secret | Client secret |
| app_key | App Key |
| scope | Escopo da cobrança |
| numero_convenio | Número do convênio bancário |
Fonte: Portal oficial de APIs do Banco do Brasil. apis.bb.com.br
Siga os passos para criar um novo projeto, associando-o à sua empresa.
client_id: Identificador único da sua aplicação.client_secret: Chave secreta associada ao seu client_id. Atenção: Copie e armazene-o imediatamente em local seguro, pois geralmente é exibido apenas uma vez.app_key: Chave de aplicativo específica para seu projeto.Fonte: Interface e documentação do Portal ApisBB.
scope da aplicaçãoscope (escopo) não é algo que você "obtem", mas sim que você define e solicita durante a configuração da sua aplicação no ApisBB. Ele especifica as permissões que sua aplicação terá.Fonte: Documentação de OAuth 2.0 e da API de Boletos do Banco do Brasil no ApisBB.
numero_convenio da contanumero_convenio é informado no contrato assinado com o Banco do Brasil para o serviço de cobrança (boletos).Fonte: Documentação interna do Banco do Brasil para empresas e Internet Banking PJ.
client_id, client_secret, app_key) são dados sensíveis. Implemente práticas de segurança robustas para seu armazenamento e uso, como criptografia e controle de acesso rigoroso. Nunca os exponha em códigos-fonte públicos ou em ambientes não seguros.numero_convenio e a configuração da API correspondam ao tipo de convênio que sua empresa possui para evitar erros na emissão dos boletos.Para configurar os parâmetros obtidos, siga as seguintes etapas:
{
"client_id": "aa1b2c3a1b2c3a1b2c3",
"client_secret": "c3b2a1c3b2a1c3b2a1c3b2a1c3b2a1c3b2a1c3b2a1c3",
"app_key": "abbac1123",
"scope": "boleto_abc_123",
"numero_convenio": "123123123"
}*Este procedimento é obrigatório para permitir que o ZP Cobrança se comunique com o sistema bancário do BB via API.