gerencianet/gn-api-sdk-node

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# gn-api-sdk-node

> A nodejs module for integration of your backend with the payment services provided by [Gerencianet](http://gerencianet.com.br).

> Um módulo nodejs para integrar seu backend com os serviços de pagamento da [Gerencianet](http://gerencianet.com.br).

[![NPM](https://nodei.co/npm/gn-api-sdk-node.png?downloads=true&stars=true)](https://nodei.co/npm/gn-api-sdk-node/)

## Instalação

```bash
$ npm install gn-api-sdk-node
```

## Uso Básico

Importe o módulo:

```js
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](examples/credentials.js) de modelo.

```js
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:

```js
const gerencianet = new Gerencianet(options)
```

Crie uma cobrança:

```js
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:

```bash
$ 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:

```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:

```bash
$ 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](https://github.com/gerencianet/gn-api-sdk-node/tree/master/CHANGELOG.md)

## License

[MIT](LICENSE)