sdk-node-apis-efi

SDK Node.js para APIs Efí Pay

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

Instalação

$ npm install sdk-node-apis-efi

Uso Básico

Importe o módulo:

const EfiPay = require('sdk-node-apis-efi')

OU

import EfiPay from 'sdk-node-apis-efi'

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.

Instancie o módulo passando as options:

const efipay = new EfiPay({
	sandbox: false, // true para homologação e false para produção
	client_id: 'seuClientId',
	client_secret: 'seuClientSecret',
	certificate: 'caminho/Ate/O/Certificado/Pix', // Caminho até o certificado Pix ou base64 do certificado
	cert_base64: false, // true se o certificado for base64
})

Crie uma cobrança:

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

efipay.createCharge({}, chargeInput)
	.then((resposta) => {
		console.log(resposta) // Aqui você tera acesso a resposta da API e os campos retornados de forma intuitiva
	})
	.catch((error) => {
		if (error instanceof EfiPayRequestCobrancasError) { // EfiPayRequestCobrancasError importado de efi-lib-node-api-errors
			console.log(error) // Aqui você validou que o erro é da API de Cobranças e terá acesso as propriedades do erro de forma intuitiva
		}
	})

Exemplos

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

$ git clone [e-mail]:efipay/sdk-node-apis-efi.git
$ cd sdk-node-apis-efi/examples
$ npm install

Defina suas credenciais em credentials.js:

module.exports = {
	sandbox: false, // true para homologação e false para produção
	client_id: 'seuClientId',
	client_secret: 'seuClientSecret',
	certificate: 'caminho/Ate/O/Certificado/Pix', // Caminho até o certificado Pix ou base64 do certificado
	cert_base64: false, // true se o certificado for base64
}

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.sejaefi.com.br/.

License

MIT