mkauth-node-api

Client em node.js para API do sistema Mk-Auth de controle de provedores. Este pacote oferece suporte à todos os recursos oferecidos pela mini API do sistema.

v2.0

Esta versão apenas corrige a url da API para a nova forma de autenticar as requisições.

Se você tem uma versão muito antiga do Mk-Auth, talvez precise usar a versão 1 d pacote.

Métodos suportados

Clientes
- listar tudo
- detalhar um cliente específico
Titulo
- listar tudo
- detalhar um título específico
- receber
chamado
- listar tudo
- detalhar um chamado específico
Conta
- listar tudo
- detalhar uma conta específica
Empresa
- listar tudo
Instalacao
- listar tudo
- detalhar uma instalação específica
Plano
- listar tudo
- detalhar um plano específico
Usuario
- listar tudo
- detalhar um usuário específico
Caixa
- listar tudo
- listar operações de um usuário específico

Instalando e usando

Para instalar o pacote:

npm i --save mkauth-node-api

Depois no seu código:

'use strict';

// substitua pelo ip do seu servidor
const server_ip = '172.31.255.2';
// substitua pelo token do seu sistema
// consulte seu token no menu Provedor/Dados da empresa dentro do mkauth
const api_token = '1234567890';

const MkAuthClient = require('mkauth-node-api');
const mkauth = new MkAuthClient(server_ip, api_token);

// lista todos os clientes
mkauth.cliente.listAll()
	.then(response=>{
		response.forEach(cliente=>{
		    console.log(cliente.nome);
		});
	});

// lista todos os clientes filtrando o resultado
const filter_cbk = cliente=>/felipe/i.test(cliente.nome);

mkauth.cliente.listAll(filter_cbk)
    .then(response=>{
        response.forEach(cliente=>{
            console.log(cliente.nome);
        });
    });

// detalha um cliente específico
mkauth.cliente.list('cliente@provedor.com.br')
    .then(response=>{
        console.log(response);
    });

//lista todos os títulos
mkauth.titulo.listAll()
    .then(response=>{
        response.forEach(titulo=>{
            console.log(`${titulo.titulo} - ${titulo.valor}`);
        });
    });

API Reference

MkAuthClient

Kind: global class

MkAuthClient
- new MkAuthClient(IP, Token)
- .cliente : Cliente
- .titulo : Titulo
- .chamado : Chamado
- .plano : Plano
- .conta : Conta
- .empresa : Empresa
- .instalacao : Instalacao
- .usuario : Usuario
- .caixa : Caixa

new MkAuthClient(IP, Token)

Construtor, cria uma nova instância do cliente

Param	Type	Description
IP	`String`	do servidor MK-AUTH
Token	`String`	para usar API do sistema, consulte o seu dentro do menu Provedor/Dados da empresa/KEY API

mkAuthClient.cliente : `Cliente`

Kind: instance property of MkAuthClient

mkAuthClient.titulo : `Titulo`

Kind: instance property of MkAuthClient

mkAuthClient.chamado : `Chamado`

Kind: instance property of MkAuthClient

mkAuthClient.plano : `Plano`

Kind: instance property of MkAuthClient

mkAuthClient.conta : `Conta`

Kind: instance property of MkAuthClient

mkAuthClient.empresa : `Empresa`

Kind: instance property of MkAuthClient

mkAuthClient.instalacao : `Instalacao`

Kind: instance property of MkAuthClient

mkAuthClient.usuario : `Usuario`

Kind: instance property of MkAuthClient

mkAuthClient.caixa : `Caixa`

Kind: instance property of MkAuthClient

Caixa

Kind: global class

Caixa
- .list(login) ⇒ Promise
- .listAll([filter_cbk]) ⇒ Promise

caixa.list(login) ⇒ `Promise`

Obtem as movimentações em caixa feitas por um determinado usuário.

Kind: instance method of Caixa

Param	Type	Description
login	`String`	Login do usuário que se deseja listar as movimentaçẽs

caixa.listAll([filter_cbk]) ⇒ `Promise`

Lista todas as operações em caixa

Kind: instance method of Caixa

Param	Type	Description
[filter_cbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

Cliente

Kind: global class

Cliente
- .list(login) ⇒ Promise
- .listAll([filterCbk]) ⇒ Promise

cliente.list(login) ⇒ `Promise`

Obtem dados detalhados de um cliente usando o login como chave de busca

Kind: instance method of Cliente

Param	Type	Description
login	`String`	login do cliente que se deseja

cliente.listAll([filterCbk]) ⇒ `Promise`

Lista todos os usuários.

Kind: instance method of Cliente

Param	Type	Description
[filterCbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

Titulo

Kind: global class

Titulo
- .list(numero_titulo) ⇒ Promise
- .listAll([filter_cbk]) ⇒ Promise
- .receber(numero_titulo) ⇒ Promise

titulo.list(numero_titulo) ⇒ `Promise`

Obtem detalhes de um título específico

Kind: instance method of Titulo

Param	Type	Description
numero_titulo	`Number`	Numero do titulo que se deseja

titulo.listAll([filter_cbk]) ⇒ `Promise`

Lista todos os titulos

Kind: instance method of Titulo

Param	Type	Description
[filter_cbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

titulo.receber(numero_titulo) ⇒ `Promise`

Receber um título em aberto

Kind: instance method of Titulo

Param	Type	Description
numero_titulo	`Number`	Número do título a dar baixa

Chamado

Kind: global class

Chamado
- .list(id_chamado) ⇒ Promise
- .listAll([filter_cbk]) ⇒ Promise

chamado.list(id_chamado) ⇒ `Promise`

Obtem detalhes de um chamado específico

Kind: instance method of Chamado

Param	Type	Description
id_chamado	`String`	ID do chamado no sistema

chamado.listAll([filter_cbk]) ⇒ `Promise`

Lista todos os chamados no sistema

Kind: instance method of Chamado

Param	Type	Description
[filter_cbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

Plano

Kind: global class

Plano
- .list(nome) ⇒ Promise
- .listAll([filterCbk]) ⇒ Promise

plano.list(nome) ⇒ `Promise`

Detalha um plano no sistema

Kind: instance method of Plano

Param	Type	Description
nome	`String`	Nome do plano que se deseja

plano.listAll([filterCbk]) ⇒ `Promise`

Listar todos os planos do sistema

Kind: instance method of Plano

Param	Type	Description
[filterCbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

Conta

Kind: global class

Conta
- .list(numero_conta) ⇒ Promise
- .listAll([filter_cbk]) ⇒ Promise

conta.list(numero_conta) ⇒ `Promise`

Detalha uma conta bancária do sistema

Kind: instance method of Conta

Param	Type	Description
numero_conta	`Number`	Número da conta que se deseja

conta.listAll([filter_cbk]) ⇒ `Promise`

Lista todas as contas bancárias

Kind: instance method of Conta

Param	Type	Description
[filter_cbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

Empresa

Kind: global class

empresa.listAll() ⇒ `Promise`

Lista os dados cadastrais da empresa

Kind: instance method of Empresa

Instalacao

Kind: global class

Instalacao
- .list(id) ⇒ Promise
- .listAll([filterCbk]) ⇒ Promise

instalacao.list(id) ⇒ `Promise`

Detalha uma instalação

Kind: instance method of Instalacao

Param	Type	Description
id	`Number`	ID da instalação que se deseja

instalacao.listAll([filterCbk]) ⇒ `Promise`

Lista todas as instalações

Kind: instance method of Instalacao

Param	Type	Description
[filterCbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

Usuario

Kind: global class

Usuario
- .list(login) ⇒ Promise
- .listAll([filterCbk]) ⇒ Promise

usuario.list(login) ⇒ `Promise`

Detalha um usuário do sistema

Kind: instance method of Usuario

Param	Type	Description
login	`String`	Login do usuário no sistema

usuario.listAll([filterCbk]) ⇒ `Promise`

Lista todos os usuários do sistema

Kind: instance method of Usuario

Param	Type	Description
[filterCbk]	`function`	Essa callback será repassada para `Array.filter()`, filtrando o resultado da listagem

mkauth-node-api

mkauth-node-api

v2.0

Métodos suportados

Instalando e usando

API Reference

MkAuthClient

new MkAuthClient(IP, Token)

mkAuthClient.cliente : Cliente

mkAuthClient.titulo : Titulo

mkAuthClient.chamado : Chamado

mkAuthClient.plano : Plano

mkAuthClient.conta : Conta

mkAuthClient.empresa : Empresa

mkAuthClient.instalacao : Instalacao

mkAuthClient.usuario : Usuario

mkAuthClient.caixa : Caixa

Caixa

caixa.list(login) ⇒ Promise

caixa.listAll([filter_cbk]) ⇒ Promise

Cliente

cliente.list(login) ⇒ Promise

cliente.listAll([filterCbk]) ⇒ Promise

Titulo

titulo.list(numero_titulo) ⇒ Promise

titulo.listAll([filter_cbk]) ⇒ Promise

titulo.receber(numero_titulo) ⇒ Promise

Chamado

chamado.list(id_chamado) ⇒ Promise

chamado.listAll([filter_cbk]) ⇒ Promise

Plano

plano.list(nome) ⇒ Promise

plano.listAll([filterCbk]) ⇒ Promise

Conta

conta.list(numero_conta) ⇒ Promise

conta.listAll([filter_cbk]) ⇒ Promise

Empresa

empresa.listAll() ⇒ Promise

Instalacao

instalacao.list(id) ⇒ Promise

instalacao.listAll([filterCbk]) ⇒ Promise

Usuario

usuario.list(login) ⇒ Promise

usuario.listAll([filterCbk]) ⇒ Promise

Readme

Keywords

Package Sidebar

Install

Repository

Homepage

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

mkAuthClient.cliente : `Cliente`

mkAuthClient.titulo : `Titulo`

mkAuthClient.chamado : `Chamado`

mkAuthClient.plano : `Plano`

mkAuthClient.conta : `Conta`

mkAuthClient.empresa : `Empresa`

mkAuthClient.instalacao : `Instalacao`

mkAuthClient.usuario : `Usuario`

mkAuthClient.caixa : `Caixa`

caixa.list(login) ⇒ `Promise`

caixa.listAll([filter_cbk]) ⇒ `Promise`

cliente.list(login) ⇒ `Promise`

cliente.listAll([filterCbk]) ⇒ `Promise`

titulo.list(numero_titulo) ⇒ `Promise`

titulo.listAll([filter_cbk]) ⇒ `Promise`

titulo.receber(numero_titulo) ⇒ `Promise`

chamado.list(id_chamado) ⇒ `Promise`

chamado.listAll([filter_cbk]) ⇒ `Promise`

plano.list(nome) ⇒ `Promise`

plano.listAll([filterCbk]) ⇒ `Promise`

conta.list(numero_conta) ⇒ `Promise`

conta.listAll([filter_cbk]) ⇒ `Promise`

empresa.listAll() ⇒ `Promise`

instalacao.list(id) ⇒ `Promise`

instalacao.listAll([filterCbk]) ⇒ `Promise`

usuario.list(login) ⇒ `Promise`

usuario.listAll([filterCbk]) ⇒ `Promise`

Weekly Downloads