node-sitef
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

A biblioteca consiste da portabilidade da DLL do SiTef para aplicações JavaScript. Ela foi desenvolvida em C++ portando para uma classe JavaScript utilizando Node Addons.

Configuração

Adicione o pacote no seu projeto utilizando yarn add node-sitef ou npm install node-sitef. Após adicionar o pacote, no root do seu projeto, adicione o arquivo CliSiTef.ini para configurar o SiTef. Ele deve ser adicionado no root para que a biblioteca possa encontrá-lo.

Este passo é muito importante, pois, mesmo que você consiga instanciar o objeto do SiTef, quando você tentar executar qualquer função será retornado zero (sucesso). O motivo disso é desconhecido, é uma particularidade da DLL.

Por fim, crie uma pasta bin na sua aplicação (ou algum outro nome de sua preferência) e adicione as DLLs do SiTef. Elas serão utilizadas para instanciar o client.

Utilização

Para utilizar a biblioteca basta importá-la e instanciar o client informando o caminho para as DLLs do SiTef. Através do client que serão realizadas todas as funções do SiTef.

const path = require('path');
const SiTef = require('node-sitef');
 
// Cria o caminho para as DLLs
const dllPath = path.resolve(__dirname, '..', 'bin', 'libclisitef.so');
const client = new SiTef(dllPath);

Após instanciado basta utilizar as funções da DLL. Para mais informações basta acessar a Wiki do projeto.

Por fim, existem dois exemplos de uso na pasta example, o qual você pode utilizar como base. Caso queira rodar os exemplos, clone o projeto, instale as dependências e execute os exemplos.

# Clonando o projeto 
git clone https://github.com/danielccunha/node-sitef.git
cd node-sitef
 
# Instalando as dependências 
yarn
 
# Executa o projeto básico, o qual apenas instancia o cliente do SiTef, 
# verifica a presença do PinPad e escreve uma mensagem se possível 
yarn example:basic
 
# Executa o projeto do client, que é um cliente interativo para teste das 
# funções da biblioteca. Nesse client é possível realizar toda a função de 
# pagamento descrita na documentação da Software Express 
yarn example:client

Tecnologias

Como contribuir

  1. Faça o fork do projeto
  2. Crie uma branch para sua modificação (git checkout -b feature/AmazingFeature)
  3. Faça o commit (git commit -am 'Add some amazing feature')
  4. Push (git push origin feature/AmazingFeature)
  5. Crie um novo Pull Request

Contribuidores

Daniel Cunha
Daniel Cunha
Felipe Furst
Felipe Furst

Licença

Este projeto está sob a licença GNU General Public License v3.0. Acesse LICENSE para mais detalhes.

Readme

Keywords

none

Package Sidebar

Install

npm i node-sitef

Weekly Downloads

23

Version

1.4.0

License

GPL-3.0

Unpacked Size

447 kB

Total Files

53

Last publish

Collaborators

  • danielcunha