mangati/sicoob-sdk

v1.1.0 2025-02-18 19:36 UTC

Requires

• php: >=8.1
• phpdocumentor/reflection-docblock: ^5.3
• symfony/http-client: ^5.3|^6.0|^7.0
• symfony/property-access: ^6.1|^7.0
• symfony/serializer: ^6.1|^7.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.5
• slevomat/coding-standard: ^8.14
• squizlabs/php_codesniffer: ^3.8

MIT

• Rogério Lino

README

Configuração

use Mangati\Sicoob\SicoobClient;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\HttpClient\HttpOptions;;


$localCert = "path/to/cert.pem";
$localPk = "path/to/cert.key";

$options = new HttpOptions();
$options
    ->setLocalCert($localCert)
    ->setLocalPk($localPk);

$client = HttpClient::create(
    defaultOptions: $options->toArray(),
);

// pix
$sicoob = new SicoobPixClient($client);
// boleto
$sicoob = new SicoobCobrancaBancariaClient($client);
// conta corrente
$sicoob = new SicoobContaCorrenteClient($client);

Autenticação

Produção:

use Mangati\Sicoob\Dto\TokenRequest;
use Mangati\Sicoob\Types\TokenScope;

$response = $sicoob->token(new TokenRequest(
    clientId: $clientId,
    scopes: [ TokenScope::COBRANCA_BOLETOS_INCLUIR ],
));

print_r($response);
// output:
//
// Mangati\Sicoob\Dto\TokenResponse Object
// (
//   [token] => Mangati\Sicoob\Dto\AuthenticationToken Object
//     (
//       [clientId] => <client_id>
//       [tokenType] => Bearer
//       [accessToken] => <generated_token>
//       [expiresIn] => 300
//       [refreshExpiresIn] => 0
//       [scopes] => Array
//          (
//            [0] => Mangati\Sicoob\Types\TokenScope Enum:string
//              (
//                [name] => COBRANCA_BOLETOS_INCLUIR
//                [value] => boletos_inclusao
//              )
//          )
//       [isSandbox] => false
//     )
// )

Sandbox:

use Mangati\Sicoob\SicoobCobrancaBancariaClient;
use Mangati\Sicoob\Dto\AuthenticationToken;

// Acesse https://developers.sicoob.com.br/portal/sandbox 
// para pegar o "Client ID" e o "Access Token (Bearer)"

/** @var AuthenticationToken */
$token = SicoobCobrancaBancariaClient::sandboxToken(
    clientId: '<sandbox-client-id>',
    accessToken: '<sandbox-access-token>',
);

Cobrança Bancária - Boleto

use Mangati\Sicoob\Dto\CobrancaBancaria\IncluirBoletoRequest;
use Mangati\Sicoob\Model\CobrancaBancaria\Boleto;

$auth = $sicoob->token(new TokenRequest(
    clientId: $clientId,
    scopes: [ TokenScope::COBRANCA_BOLETOS_INCLUIR ],
));

$response = $sicoob->incluirBoleto($auth->token, new IncluirBoletoRequest(
    boleto: new Boleto(),
));

/** @var Boleto */
$boleto = $response->resultado;

$base64Data = $boleto->pdfBoleto;
$nossoNumero = $boleto->nossoNumero;

Cobrança Bancária - Movimentações

use Mangati\Sicoob\Helper\CobrancaBancaria\MovimentacoesDownloader;
use Mangati\Sicoob\Model\CobrancaBancaria\Movimentacao;

$auth = $sicoob->token(new TokenRequest(
    clientId: $clientId,
    scopes: [ TokenScope::COBRANCA_BOLETOS_CONSULTAR ],
));

$downloader = new MovimentacoesDownloader($sicoob);

/** @var Generator<Movimentacao> */
$movimentacoes = $downloader->download(
    $token,
    $numeroCliente,
    $tipoMovimento,
    $dataInicial,
    $dataFinal
);

foreach ($movimentacoes as $movimentacao) {
    print_r($movimentacao);
    // Mangati\Sicoob\Model\CobrancaBancaria\Movimentacao Object
    // (
    //     [siglaMovimento] => ENTR
    //     [dataInicioMovimento] => DateTimeImmutable
    //     [dataFimMovimento] => DateTimeImmutable
    //     [numeroCliente] => 123456
    //     [numeroContrato] => 987654
    //     [modalidade] => 1
    //     [numeroTitulo] => 1004
    //     [seuNumero] => 100
    //     [dataVencimentoTitulo] => DateTimeImmutable
    //     [valorTitulo] => 150
    //     [codigoBarras] => 75600000000000000000000000000000000000000001
    //     [dataMovimentoEntrada] => DateTimeImmutable
    //     [dataEmissaoDocumento] => DateTimeImmutable
    //     [dataLimitePagamento] => DateTimeImmutable
    //     [numeroContaCorrente] => 102938
    //     [valorTarifaMovimento] => 0
    //     [numeroContratoCobranca] => 1234
    // )
}