omie-api-node
v1.0.5
Published
Omie API wrapper for Node.js
Downloads
12
Readme
Omie Node Api
Trying to encapsulate omie ERP API in a more easy to use interface with promises.
How to use
Instantiate the Omie class with your appKey and appSecret
const Omie = require('omie-node-api');
const appSecret = 'YOUR_APP_SECRET';
const appKey = 'YOUR_APP_KEY';
const OmieClient = new Omie({ appSecret, appKey });
Endpoints registration
You can register all endpoints by doing
OmieClient.registerAll();
or just register the ones you need by passing their endpoints in an Array
OmieClient.registerEndpoints(['geral/clientes', 'geral/paises']);
Calling the API
After instantiating and registering all or some endpoints, you can call the API like this.
/**
* Calling the api when endpoint = 'geral/clientes'
*
* @param {Object} payload request payload
* @param {(Object|undefined)} headers Extra headers (optional)
**/
OmieClient.geral.clientes
.IncluirCliente(payload, headers)
.then((body) => {
// do something
})
.catch((err) => {
// fail and do something
});
Visit the docs or check /resources/resources.json
to check which methods are
available for each endpoint.
Valid endpoints
geral/clientetag
-> Ver Documentaçaogeral/clientes
-> Ver Documentaçaogeral/projetos
-> Ver Documentaçaogeral/empresas
-> Ver Documentaçaogeral/departamentos
-> Ver Documentaçaogeral/categorias
-> Ver Documentaçaogeral/parcelas
-> Ver Documentaçaogeral/tpativ
-> Ver Documentaçaogeral/cidades
-> Ver Documentaçaogeral/paises
-> Ver Documentaçaogeral/contacorrente
-> Ver Documentaçaogeral/bancos
-> Ver Documentaçaogeral/tiposdoc
-> Ver Documentaçaogeral/tipocc
-> Ver Documentaçaogeral/dre
-> Ver Documentaçaogeral/produtos
-> Ver Documentaçaogeral/prodcaract
-> Ver Documentaçaogeral/malha
-> Ver Documentaçaogeral/familias
-> Ver Documentaçaogeral/unidade
-> Ver Documentaçaogeral/cenarios
-> Ver Documentaçaogeral/vendedores
-> Ver Documentaçaogeral/caracteristicas
-> Ver Documentaçaogeral/meiospagamento
-> Ver Documentaçaoprodutos/cnae
-> Ver Documentaçaoprodutos/requisicaocompra
-> Ver Documentaçaoprodutos/pedidocompra
-> Ver Documentaçaoprodutos/op
-> Ver Documentaçaoprodutos/formaspagcompras
-> Ver Documentaçaoprodutos/ncm
-> Ver Documentaçaoprodutos/cfop
-> Ver Documentaçaoprodutos/icmscst
-> Ver Documentaçaoprodutos/icmscsosn
-> Ver Documentaçaoprodutos/icmsorigem
-> Ver Documentaçaoprodutos/piscst
-> Ver Documentaçaoprodutos/cofinscst
-> Ver Documentaçaoprodutos/ipicst
-> Ver Documentaçaoprodutos/ipienq
-> Ver Documentaçaoprodutos/tpcalc
-> Ver Documentaçaoprodutos/cest
-> Ver Documentaçaoprodutos/pedido
-> Ver Documentaçaoprodutos/pedidovendaanexos
-> Ver Documentaçaoprodutos/pedidovendafat
-> Ver Documentaçaoprodutos/pedidoetapas
-> Ver Documentaçaoprodutos/cte
-> Ver Documentaçaoprodutos/remessa
-> Ver Documentaçaoprodutos/cupomfiscalincluir
-> Ver Documentaçaoprodutos/cupomfiscal
-> Ver Documentaçaoprodutos/formaspagvendas
-> Ver Documentaçaoprodutos/tabelaprecos
-> Ver Documentaçaoprodutos/etapafat
-> Ver Documentaçaoprodutos/nfconsultar
-> Ver Documentaçaoprodutos/notafiscalutil
-> Ver Documentaçaocrm/contas
-> Ver Documentaçaocrm/contatos
-> Ver Documentaçaocrm/oportunidades
-> Ver Documentaçaocrm/tarefas
-> Ver Documentaçaocrm/solucoes
-> Ver Documentaçaocrm/fases
-> Ver Documentaçaocrm/usuarios
-> Ver Documentaçaocrm/status
-> Ver Documentaçaocrm/motivos
-> Ver Documentaçaocrm/tipos
-> Ver Documentaçaocrm/parceiros
-> Ver Documentaçaocrm/finders
-> Ver Documentaçaocrm/origens
-> Ver Documentaçaocrm/concorrentes
-> Ver Documentaçaocrm/verticais
-> Ver Documentaçaofinancas/contapagar
-> Ver Documentaçaofinancas/contareceber
-> Ver Documentaçaofinancas/contacorrentelancamentos
-> Ver Documentaçaofinancas/extrato
-> Ver Documentaçaofinancas/caixa
-> Ver Documentaçaofinancas/pesquisartitulos
-> Ver Documentaçaofinancas/mf
-> Ver Documentaçaofinancas/contapagaranexos
-> Ver Documentaçaofinancas/contareceberanexos
-> Ver Documentaçaoestoque/comprador
-> Ver Documentaçaoestoque/produtofornecedor
-> Ver Documentaçaoestoque/ajuste
-> Ver Documentaçaoestoque/consulta
-> Ver Documentaçaoestoque/movestoque
-> Ver Documentaçaoservicos/servico
-> Ver Documentaçaoservicos/osp
-> Ver Documentaçaoservicos/os
-> Ver Documentaçaoservicos/nfse
-> Ver Documentaçaoservicos/listaservico
-> Ver Documentaçaoservicos/contrato
-> Ver Documentaçaoservicos/tipotrib
-> Ver Documentaçaoservicos/lc116
-> Ver Documentaçaoservicos/nbs
-> Ver Documentaçaoservicos/ibpt
-> Ver Documentaçaoservicos/contratotpfat
-> Ver Documentaçaocontador/xml
-> Ver Documentaçao
This is not an official module
Still under development