gn-api-sdk-node

Module for integration with Gerencianet API

Usage no npm install needed!

<script type="module">
  import gnApiSdkNode from 'https://cdn.skypack.dev/gn-api-sdk-node';
</script>

README

gn-api-sdk-node

A nodejs module for integration of your backend with the payment services provided by Gerencianet.

Um módulo nodejs para integrar seu backend com os serviços de pagamento da Gerencianet.

NPM

Build Status Code Climate Test Coverage Dependency Status npm version

Instalação

$ npm install gn-api-sdk-node

Uso Básico

Importe o módulo:

var Gerencianet = require('gn-api-sdk-node');

Insira suas credenciais e defina se deseja usar o sandbox ou não. Você também pode usar o arquivo examples/credentials.js de modelo.

module.exports = {
    // PRODUÇÃO = false
    // HOMOLOGAÇÃO = true
    sandbox: false,

    // CREDENCIAIS DE PRODUÇÃO
    clientIdProducao: '',
    clientSecretProducao: '',
    pathCertProducao: '',

    // CREDENCIAIS DE HOMOLOGAÇÃO
    clientIdHomologacao: '',
    clientSecretHomologacao: '',
    pathCertHomologacao: '',

    // VALIDAR MTLS?
    validateMtls: false,
};

Instancie o módulo passando as options:

var gerencianet = new Gerencianet(options);

Crie uma cobrança:

var chargeInput = {
  items: [{
    name: 'Product A',
    value: 1000,
    amount: 2
  }]
}

gerencianet
  .createCharge({}, chargeInput)
  .then(console.log)
  .catch(console.log)
  .done();

Exemplos

Para executar os exemplos, clone este repo e instale as dependências:

$ git clone git@github.com:gerencianet/gn-api-sdk-node.git
$ cd gn-api-sdk-node/examples
$ npm install

Defina suas credenciais em credentials.js:

module.exports = {
    // PRODUÇÃO = false
    // HOMOLOGAÇÃO = true
    sandbox: false,

    // CREDENCIAIS DE PRODUÇÃO
    clientIdProducao: '',
    clientSecretProducao: '',
    pathCertProducao: '',

    // CREDENCIAIS DE HOMOLOGAÇÃO
    clientIdHomologacao: '',
    clientSecretHomologacao: '',
    pathCertHomologacao: '',

    // VALIDAR MTLS?
    validateMtls: false,
};

Em seguida, execute o exemplo que você deseja:

$ node createCharge.js

Documentação

A documentação completa com todos os endpoints disponíveis você encontra em: https://dev.gerencianet.com.br/.

Changelog

CHANGELOG

License

MIT