README

PHP ShopFacil Bradesco Registro de Boletos SDK

Este SDK é designado à ajudar desenvolvedores PHP à integrar seus projetos com ShopFacil Bradesco no intuito de registrar boletos..

Instalação

composer require tarcisioruas/bradesco-registro-online

Precisa de ajuda com a instalação?

Instale o Composer

Se o comando de instalação acima não funcionar, instale o composer usando as instruções de instalação abaixo e tente novamente.

Debian / Ubuntu

sudo apt-get install curl
curl -s http://getcomposer.org/installer | php
php composer.phar install

Após a instalação do composer, repita o comando de instalação do sdk abaixo:

php composer.phar require tarcisioruas/bradesco-registro-online

Windows:

Faça o download do Composer para Windows

Observações

Para usar com PHP stream wrapper, a opção allow_url_fopen precisa estar ativada dentro do php.ini do sistema
Para usar com cURL, a versão do cURL precisa ser maior ou igual que a 7.19.4, e deve estar complilada com OpenSSL e zlib

Como Usar

Configurações Preliminares

Para se conectar à API do ShopFacil Bradesco, é necessário ter em mãos as credenciais de acesso. Para obter às suas, entrem em contato com o suporte responsável.

Códigos de Exemplo

Registrando um boleto.

<?php
require 'vendor/autoload.php';

use ShopFacil\Registro\Pessoa;
use ShopFacil\Registro\Boleto;
use ShopFacil\Registro\Registro;
use ShopFacil\Registro\Exceptions\EntidadeException;
use ShopFacil\Registro\Exceptions\HttpException;

$nome = 'Nome de Uma Pessoa';
$cpf = '1234567890';
$pagador = new Pessoa($nome, $cpf);

/*
 * Definindo o endereço do pagador, esse passo só é necessário caso o banco seja o responsável por emitir 
 * a papeleta. 
 */
$pagador->setEnderecoCEP('12345678')
        ->setEnderecoLogradouro('Um Logradouro')
        ->setEnderecoNumero('123')
        ->setEnderecoBairro('Um Bairro')
        ->setEnderecoCidade('São Paulo')
        ->setEnderecoComplemento('Bloco 10, Apto 444')
        ->setEnderecoUF('SP');

// Iniciando a configuração do boleto
$valorDoBoleto = 150.30;
$vencimento = '2020-12-24';
$nossoNumero = 1234; //Indentificador do Boleto, pedido ou referencia interna do sistema
$boleto = new Boleto($pagador, $valorDoBoleto, $vencimento, $nossoNumero);

// Definindo um percentual de multa, caso seja desejável (2.00%)
$boleto->setPercentualMulta(2);

// Definindo um percentual de juros, caso seja desejável (0.033%)
$boleto->setPercentualJuros(0.033);


// Definindo um desconto por antecipação, caso seja desejável
// Atribuindo valor de descontos
$descontoPorPagamentoAntecipado = 20.45;
$dataLimiteDeDesconto = '2020-12-10';
$boleto->setValorDesconto($descontoPorPagamentoAntecipado, $dataLimiteDeDesconto);

// Requisitando o registro do boleto
$merchantId = 'seuMerchantIdAqui';
$senha = 'suaSenhaAqui';

// Ou Registro::PRODUCAO
$ambiente = Registro::HOMOLOGACAO;

// Por padrão, o cURL será usado. 
$registro = new Registro($ambiente, $merchantId, $senha);

/* 
* Se desejar usar com PHP Stream Wrapper, use como abaixo
*/ 
$registro = new Registro($ambiente, $merchantId, $senha, new ShopFacil\Registro\StreamHttp());

try
{
    $retorno = $registro->registrar($boleto);

    // Verificando se o boleto foi registrado com sucesso
    if ($retorno->registrado()) {
        echo 'Boleto registrado com sucesso <br />';
    }

    // Mostrando código de retorno e mensagem
    $codigoRespostaHttp = $retorno->getCodigoRespostaHttp();
    $codigoResposta = $retorno->getCodigoResposta();
    $mensagemResposta = $retorno->getMensagemResposta();

    echo $codigoRespostaHttp . ' - ' . $codigoResposta . ' - ' . $mensagemResposta . '<br />';
} 
catch (EntidadeException $e) 
{
    var_dump($e->getInconsistencias());
}
catch (HttpException $e) 
{
    echo $e->getMessage();
}

Desenvolvimento

Quer contribuir? Ótimo!

Se encontrou e corrigiu um bug ou implementou uma nova funcionalidade, sinta-se à vontade para nos enviar um pull request. Você será adicionado à lista de desenvolvedores automaticamente.

tarcisioruas / bradesco-registro-online

Maintainers

Details