Skip to content

Latest commit

 

History

History
130 lines (84 loc) · 4.44 KB

README.md

File metadata and controls

130 lines (84 loc) · 4.44 KB
Raw

Interbank-Go

A biblioteca interbank-go é uma implementação em Go para interagir com a API do Banco Inter. Ela fornece funcionalidades para autenticação (Token de acesso gerenciado automaticamente (thread-safe)), operações bancárias, cobranças e transações PIX.

Instalação

go get github.com/raniellyferreira/interbank-go

Como usar

// Cria um cliente usando as variáveis de ambiente (INTERBANK_CLIENT_ID, INTERBANK_CLIENT_SECRET, INTERBANK_SCOPES e INTERBANK_TLS_PATH)
client, err := inter.NewClient()
// ...

// Use o ambiente sandbox (é o mesmo que client.SetURL("https://cdpj-sandbox.partners.uatinter.co"))
client.UseSandBox()

// Defina a conta corrente a ser usada (opcional)
client.SetAccountNumber("12345678")

// ConsultarSaldo
respSaldo, err := client.Banking.ConsultarSaldo(context.Background(), "2024-10-20")
// ...

log.Printf("Saldo: %+v", respSaldo.Disponivel)

Estrutura do Projeto

  • auth: Gerencia a autenticação e autorização.
  • backend: Lida com as requisições HTTP e gerenciamento de tokens.
  • banking: Fornece serviços relacionados a operações bancárias.
  • cobranca: Gerencia a emissão e consulta de cobranças.
  • pix: Implementa funcionalidades relacionadas ao sistema PIX.
  • erros: Define estruturas para tratamento de erros.
  • utils: Utilitários gerais para manipulação de dados e formatação.

Autenticação

auth/credentials.go

Gerencia as credenciais necessárias para autenticação na API do Banco Inter. As credenciais incluem clientID, clientSecret, grantType e scopes.

Variáveis de Ambiente

Para configurar as credenciais padrão, defina as seguintes variáveis de ambiente:

  • INTERBANK_CLIENT_ID: O ID do cliente obtido no detalhe da tela de aplicações no IB.
  • INTERBANK_CLIENT_SECRET: O segredo do cliente obtido no detalhe da tela de aplicações no IB.
  • INTERBANK_SCOPES: Deve ser uma lista separada por vírgulas dos escopos desejados.
  • INTERBANK_TLS_PATH: O caminho para a pasta onde o certificado TLS está localizado. O certificado deve ser nomeado tls.crt e a chave privada tls.key.
  • INTERBANK_USE_SANDBOX: Define se a aplicação deve usar o ambiente de sandbox.

Funções Principais

  • NewCredentials: Cria novas credenciais.
  • NewDefaultCredentials: Carrega credenciais padrão a partir de variáveis de ambiente.
  • credential.SetTLS: Configura o certificado TLS.
  • credential.SetScopesFromString: Define os escopos a partir de uma string.
  • credential.LoadCertAndKeyFromPath: Carrega o certificado TLS e a chave privada dos caminhos fornecidos.

Serviços Bancários

banking/extrato.go

Fornece métodos para consultar extratos e saldos.

Funções Principais

  • ExportarExtrato: Exporta o extrato da conta.
  • ConsultarExtratoCompleto: Consulta o extrato completo da conta.
  • ConsultarSaldo: Consulta o saldo da conta.

Cobrança

cobranca/cobranca.go

Gerencia a emissão de cobranças.

Funções Principais

  • Emitir: Emite uma nova cobrança.

PIX

pix/pix.go

Implementa funcionalidades para transações PIX, incluindo consultas e devoluções.

Funções Principais

  • Consultar: Consulta um pix através de um determinado EndToEndId
  • ConsultarRecebidos: Consulta PIX recebidos.
  • SolicitarDevolucao: Solicita a devolução de um PIX.
  • ConsultarDevolucao: Consulta a devolução de um PIX.

pix/pix_cob.go

Gerencia cobranças imediatas via PIX.

Funções Principais

  • CriarCobrancaImediata: Cria uma cobrança imediata.
  • CriarCobrancaImediataComTxID: Cria uma cobrança imediata com TxID.
  • EditarCobrancaImediata: Edita uma cobrança imediata.
  • ConsultarCobrancaImediata: Consulta uma cobrança imediata.
  • ConsultarCobrancasImediatas: Consulta cobranças imediatas.

pix/pix_cobv.go

Gerencia cobranças com vencimento via PIX.

Funções Principais

  • CriarCobrancaComVencimentoETxID: Cria uma cobrança com vencimento e TxID.
  • ConsultarCobrancaComVencimento: Consulta uma cobrança com vencimento.
  • ConsultarCobrancasComVencimento: Consulta cobranças com vencimento.
  • EditarCobrancaComVencimento: Edita uma cobrança com vencimento.

Requisitos

  • Go 1.23
  • Dependências externas listadas no go.mod.

Conclusão

Esta biblioteca oferece uma interface robusta e fácil de usar para integrar aplicações Go com a API do Banco Inter, suportando operações bancárias, cobranças e transações PIX de forma segura e eficiente.