- Versão em PHP
- Versão em C# (em breve)
Bling ERP API - Javascript/Typescript
Pacote de integração com a API v3 do ERP Bling para Javascript/TypeScript. O mais completo existente.
Atualizado com a versão v310 da API (veja o registro de alterações).
Atenção: a versão 5.0.0+ do bling-erp-api para Javascript/TypeScript
utiliza a API v3 do Bling. Caso deseja utilizar a API v2 do Bling,
utilize a versão 4.0.0.
Instalação
Para instalar, execute o comando:
npm i 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.
import Bling from 'bling-erp-api'
const apiKey = 'sua_api_key'
const 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) - Grupos de Produtos (
.gruposDeProdutos) - 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) - Ordens de Produção (
.ordensDeProducao) - Pedidos - Compras (
.pedidosCompras) - Pedidos - Vendas (
.pedidosVendas) - Produtos (
.produtos) - Produtos - Estruturas (
.produtosEstruturas) - Produtos - Fornecedores (
.produtosFornecedores) - Produtos - Lojas (
.produtosLojas) - Produtos - Variações (
.produtosVariacoes) - Propostas Comerciais (
.propostasComerciais) - 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:
import Bling from 'bling-erp-api'
const apiKey = 'sua_api_key'
const blingConnection = new Bling(apiKey)
const products = await blingConnection.produtos.get()
console.log(products)
Executando os testes do projeto
Faça o clone do projeto, instale as dependências e execute:
npm run test