Home
Softono
gn-api-sdk-node

gn-api-sdk-node

Open source MIT JavaScript
67
Stars
26
Forks
4
Issues
8
Watchers
2 years
Last Commit

About gn-api-sdk-node

SDK em NodeJS integrada a API Gerencianet. Esta SDK está preparada para integração à API Pix e API Boletos da Gerencianet, que lhe permite realizar o gerenciamento de cobranças Pix com QR Code e Pix Copia e Cola, boleto/Bolix, carnê, cartão de crédito e muito mais.

Platforms

Web Self-hosted

Languages

JavaScript

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

Instalação

$ npm install gn-api-sdk-node

Uso Básico

Importe o módulo:

const 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,
    client_id: 'seuClientId',
    client_secret: 'seuClientSecret',
    certificate: 'caminho/Ate/O/Certificado/Pix',
}

Instancie o módulo passando as options:

const gerencianet = new Gerencianet(options)

Crie uma cobrança:

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

gerencianet
    .createCharge({}, chargeInput)
    .then((resposta) => {
        console.log(resposta)
    })
    .catch((error) => {
        console.log(error)
    })

Exemplos

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

$ git clone [email protected]: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,
    client_id: 'seuClientId',
    client_secret: 'seuClientSecret',
    certificate: 'caminhoAteOCertificadoPix',
}

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