alebatistella/bling-erp-api

1.14.0 2024-05-09 21:55 UTC

This package is auto-updated.

Last update: 2024-05-09 22:00:14 UTC


README

Bling ERP API - PHP

Pacote de integração com a API v3 do ERP Bling para PHP 8.2+. O mais completo existente.

Atualizado com a versão v300 da API (veja o registro de alterações).

Instalação

Para instalar, execute o comando:

composer require alebatistella/bling-erp-api

Criação de uma nova conexão

Para criar uma conexão ao serviço do Bling, basta instanciar o objeto com a API key em seu construtor.

use AleBatistella\BlingErpApi\Bling;

$apiKey = "sua_api_key";
$blingConnection = new Bling($apiKey);

Vale destacar que o fluxo de criação e autorização do aplicativo não é feito pela biblioteca. Ou seja, a biblioteca somente recebe o access_token gerado a partir do endpoint /token. Veja a referência.

Para entender na prática como a autenticação citada acima funciona, veja o projeto de demonstração.

Entidades disponíveis

Todas as entidades do Bling atualmente são permitidas para interação. São elas:

  • Borderos (->borderos)
  • Campos customizados (->camposCustomizados)
  • Canais de Venda (->canaisDeVenda)
  • Categorias - Lojas (->categoriasLojas)
  • Categorias - Produtos (->categoriasProdutos)
  • Categorias - Receitas e Despesas (->categoriasReceitasDespesas)
  • Contas a Pagar (->contasPagar)
  • Contas a Receber (->contasReceber)
  • Contas Contábeis (->contasContabeis)
  • Contatos (->contatos)
  • Contatos - Tipos (->contatosTipos)
  • Contratos (->contratos)
  • Depósitos (->depositos)
  • Empresas (->empresas)
  • Estoques (->estoques)
  • Formas de pagamento (->formasDePagamento)
  • Homologação (->homologacao)
  • Logísticas (->logisticas)
  • Logísticas - Etiquetas (->logisticasEtiquetas)
  • Logísticas - Objetos (->logisticasObjetos)
  • Logísticas - Remessas (->logisticasRemessas)
  • Logísticas - Serviços (->logisticasServicos)
  • Naturezas de Operações (->naturezasDeOperacoes)
  • Notas Fiscais de Consumidor Eletrônicas (->nfces)
  • Notas Fiscais de Serviço Eletrônicas (->nfses)
  • Notas Fiscais Eletrônicas (->nfes)
  • Notificações (->notificacoes)
  • Pedidos - Compras (->pedidosCompras)
  • Pedidos - Vendas (->pedidosVendas)
  • Produtos (->produtos)
  • Produtos - Estruturas (->produtosEstruturas)
  • Produtos - Fornecedores (->produtosFornecedores)
  • Produtos - Lojas (->produtosLojas)
  • Produtos - Variações (->produtosVariacoes)
  • Situações (->situacoes)
  • Situações - Módulos (->situacoesModulos)
  • Situações - Transições (->situacoesTransicoes)
  • Usuários (->usuarios)
  • Vendedores (->vendedores)

Exemplo de uso

Para listar seus produtos, basta executar:

use AleBatistella\BlingErpApi\Bling;

$apiKey = "sua_api_key";
$blingConnection = new Bling($apiKey);

$products = $blingConnection->produtos->get();

var_dump($products);

Executando os testes do projeto

Faça o clone do projeto, instale as dependências e execute:

vendor/phpunit/phpunit/phpunit -c phpunit.xml

Contribuindo ao projeto