README.md

Biblioteca para consumo de rotas da API do Banco do Brasil

O objetivo desse projeto é facilitar o consumo de rotas do sistema de pagamentos do Banco do Brasil.

Dependências

• guzzlehttp/guzzle

Como instalar

Antes de tudo, tenha certeza de ter instalado na sua máquina o composer.

Baixe esse repositório e acople dentro do seu projeto. Depois instale as dependências do projeto com o comando composer install.

Como usar

Abaixo segue um exemplo de como utilizar:

require_onde './vendor/autoload.php';

try {
    // instanciando API do Banco do Brasil
    $api = new API(1, $client_id, $client_secret, $api_key, $convenio);

    // exemplo de como consultar detalhes de um boleto usando o numero do boleto
    $api->getBoleto('NUMERO_DO_BOLETO');

    // exemplo de como consultar todos os boletos da conta
    $params = new ParamsListAllBoletos($api_key, 'B', '', $agencia, $conta, $wallet, $wallet_variation, '', '', '', '', '', '', '', $dataInicioRegistro, $dataFimRegistro, '', '', '', '', 1);
    $api->listAllBoletos($params);
} catch () {}

Funções Implementadas

• getBoleto(:id): Busca um boleto específico e mostra detalhes sobre ele.
• listAllBoletos($params): Busca uma lista de boletos a partir dos parâmetros informados. Os parâmetros você pode ver mais detalhes observando os parâmetros de entrada da classe ParamsListAllBoletos(). OBS: esse método é recursivo, onde é puxado todos os boletos usando o parâmetro indice da API do banco do brasil.

Observações

• Atente-se a consultar a documentação da API do Banco do Brasil e pegar todas as variáveis de autenticação (essas variáveis você vai achar dentro da sua conta do Banco do Brasil).

Dúvidas ou Sugestões?

Abra uma issue em caso de dúvidas ou sugestões de melhorias!