TypeScript
Saiba como instalar e configurar nossa SDK de TypeScript para utilizar as APIs da Efí
As requisições feitas às APIs da Efí, utilizando a sdk de TypeScript precisam do certificado gerado em sua conta Efí no formato .p12.
Instalação via NPM
- Efí Pay
npm install sdk-typescript-apis-efi
Instalação via Git
Nossa SDK também está disponível em nosso repositório no Github da Efí.
- Efí Pay
$ git clone https://github.com/efipay/sdk-typescript-apis-efi.git
Testado com
Version 4.2.4
Uso Básico
Importe o módulo:
- Efí Pay
import EfiPay from 'sdk-typescript-apis-efi';
Insira suas credenciais e defina se deseja usar o sandbox ou não.
- TypeScript
export = {
// PRODUÇÃO = false
// HOMOLOGAÇÃO = true
sandbox: false,
client_id: 'seuClientId',
client_secret: 'seuClientSecret',
pix_cert: 'caminhoAteOCertificadoPix',
};
Instancie o módulo passando suas opções:
- Efí Pay
const efipay = EfiPay(options);
Crie a charge (transação):
- Efí Pay
var body = {
items: [
{
name: 'Product A',
value: 1000,
amount: 2,
},
],
};
efipay
.createCharge({}, body)
.then((resposta: any) => {
console.log(resposta);
})
.catch((error: Promise<any>) => {
console.log(error);
})
.done();
Exemplos
Para executar os exemplos, clone este repositório e instale as dependências:
- Efí Pay
$ git clone [email protected]:efipay/sdk-typescript-apis-efi.git
$ cd sdk-typescript-apis-efi/examples
$ npm install
Defina suas chaves oauth no arquivo config.ts
:
module.exports = {
// PRODUÇÃO = false
// HOMOLOGAÇÃO = true
sandbox: false,
client_id: 'seuClientId',
client_secret: 'seuClientSecret',
pix_cert: 'caminhoAteOCertificadoPix',
};
Em seguida, execute o exemplo desejado:
$ ts-node createCharge.ts