Skip to main content

Cliente não oficial feito em Python, para realizar integração com as API’s do Banco do Brasil.

Documentação oficial do BB

Instalando

Nosso pacote está hospedado no PyPI

pip install bb-wrapper

Configuração

Para utilizar o bb-wrapper é necessário ter algumas constantes/variáveis. sendo elas:

IMOBANCO_BB_IS_SANDBOX='flag True ou False para indicar utilização de sandbox ou não'
IMOBANCO_BB_BASIC_TOKEN='chave de autenticação gerada para a aplicação no site developers.bb'
IMOBANCO_BB_GW_APP_KEY='chave de desenvolvimento gerada para a aplicação no site developers.bb'

Para geração de boletos é necessário:

IMOBANCO_BB_CONVENIO='convênio do contrato para geração de boletos'
IMOBANCO_BB_CARTEIRA='carteira do contrato para geração de boletos'
IMOBANCO_BB_VARIACAO_CARTEIRA='variação da carteira do contrato para geração de boletos
IMOBANCO_BB_AGENCIA='agência da conta berço do contrato para geração de boletos'
IMOBANCO_BB_CONTA='nº da conta berço do contrato para geração de boletos'

Recomendamos criar um arquivo .env contendo essas varíaveis de ambiente.

Podem ser criadas diretamente no terminal (não recomendado).

Podem ser criadas também diretamente no `arquivo.py` (não recomendado).

Recursos disponíveis

API’s

  • ☑ API de Cobrança (geração de boletos)

  • ☑ API PIX (recebimento PIX) {essa API ainda está instável e incompleta no BB}

  • ☐ API Arrecadação PIX {sem previsão de implementação}

  • ☑ API Lotes de Pagamentos {essa API ainda está instável e incompleta no BB}

    • ☐ Transferência PIX

    • ☑ Transferência Bancária

    • ☐ Pagamento GPS

    • ☐ Pagamento GRU

    • ☐ Pagamento DARF Preto

    • ☑ Pagamento Tributos

    • ☑ Pagamento Boletos

Recursos auxiliares

  • ☑ Geração de imagem b64

  • ☑ Geração, validação e conversão de código de barras de boleto

  • ☑ Geração, validação e conversão de código de barras de tributos

  • ☑ Geração de QR Code PIX

  • ☑ Validação e limpeza de CPF/CNPJ

Exemplos disponíveis

Existem exemplos de utilização da biblioteca na pasta examples.

Preparando ambiente de desenvolvimento

> O Nix é utilizado para gerenciar os pacotes necessários, por exemplo como a versão correta do python.

Certifique-se que o ambiente está ativado, se não estiver execute:

nix develop
nix flake clone 'github:imobanco/bb-wrapper' --dest bb-wrapper \
&& cd bb-wrapper 1>/dev/null 2>/dev/null \
&& (direnv --version 1>/dev/null 2>/dev/null && direnv allow) \
|| nix develop --command sh -c 'make poetry.config.venv && make poetry.install && python -c "import requests"'

git remote set-url origin $(git remote show origin \
    | grep "Fetch URL" \
    | sed 's/ *Fetch URL: //' \
    | sed 's/https:\/\/github.com\//git@github.com:/')

Metadata

Release files for bb-wrapper 0.5.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bb-wrapper 0.5.5
File Size Uploaded
bb_wrapper-0.5.5.tar.gz 43.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bb-wrapper 0.5.5
File Interpreter ABI Platform
bb_wrapper-0.5.5-py3-none-any.whl Python 3 none any Details

Total release size: 94.0 kB

Release files / bb_wrapper-0.5.5.tar.gz

Download URL bb_wrapper-0.5.5.tar.gz
Size 43.4 kB
Tags Source
SHA-256 checksum
How to use checksums
220ec83ef7b3d256e4af8709dca25458960c44238ca4909112d3834882b78079
BLAKE2b-256 checksum
How to use checksums
04c20686703721ffec2ea6e535523e37ab761a8bc6f7277cf1555a983a64618f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.9.20 Linux/6.5.0-1025-azure

Release files / bb_wrapper-0.5.5-py3-none-any.whl

Download URL bb_wrapper-0.5.5-py3-none-any.whl
Size 50.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5824886099e312be91441c6e0bde5842b61a85300bf2275183184473fd898eff
BLAKE2b-256 checksum
How to use checksums
6971390ba40d9c0b793e04c59b1292ff858e95d9f5026150b4325ec810e74512
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.9.20 Linux/6.5.0-1025-azure

Release history Release notifications | RSS feed

This release

0.5.5 This release

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.26

2 release files

0.4.25

2 release files

0.4.23

2 release files

0.4.22

2 release files

0.4.21

2 release files

0.4.18

2 release files

0.4.17

2 release files

0.4.16

2 release files

0.4.14

2 release files

0.4.13

2 release files

0.4.11

2 release files

0.4.10

2 release files

0.4.9

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page