ins
iugu-node-sdk
npm i iugu-node-sdk
ins

iugu-node-sdk

Biblioteca não-oficial da API Iugu para Node.js feita em Typescript

by Vinicius Picanco

0.1.1 (see all)License:BSD-3-ClauseTypeScript:Built-In
npm i iugu-node-sdk
Readme

Iugu SDK para Node.JS

Com o objetivo de fornecer um SDK Node para acesso a API da Iugu de forma fácil e tipada.

Para instalar a biblioteca:

npm install iugu-node-sdk

Como usar

Com sua API key gerada pela plataformada da Iugu inicialize o sdk:

import Iugu, { IuguCustomer } from 'iugu-node-sdk'

Iugu.setApiKey('<SUA API KEY>')

Existe alguns models que foram criados para padronizar as respostas e requisição para a API. Um exemplo de utilização da API em TypeScript para criação de um cliente:

const client: IuguCustomer = {
    name: 'Vinicius Picanco',
    email: 'teste@teste.com'
}

// Pode ser utilizar com await
const resultClient : IuguCustomer = await Iugu.customers.create(client, undefined)

// Ou
Iugu.customers.create(client, undefined).then((cli: IuguCustomer) => {
    // On success
}).catch((error: Error) => {
    // On error
})

Todas os métodos seguem o parametro de Iugu.{recurso}.{método}(model,urlParams)

Os parâmetros de URL devem ser passados pelo segundo parâmetro dos métodos, da seguinte forma:

const client: IuguCustomer = {
    name: 'Vinicius Picanco',
    email: 'teste@teste.com'
}

const urlParams: Map<string, string> = new Map()
urlParams.set('id', '558958DB714B389EA6B1FF0A33D75505')

// Pode ser utilizar com await
const resultClient : IuguCustomer = await Iugu.customers.update(client, urlParams)

// Ou
Iugu.customers.create(client, urlParams).then((cli: IuguCustomer) => {
    // On success
}).catch((error: Error) => {
    // On error
})

Observação

Para saber quais requisições estão disponíveis e quais parâmetros passar acesse a documentação dev.iugu.com/reference para referência.

Testes

Para o funcionamento dos testes crie um arquivo chamado iugu_services.json na pasta tests com os seguintes dados:

{
    "accountId": "<SUA ACCOUNT ID>",
    "apiKey": "<API KEY PREFERENCIALMENTE DE TESTES>",
    "clientId": "<UM CLIENT ID VÁLIDO>",
    "paymentMethodToken": "<<UM TOKEN DE FORMA DE PAGAMENTO VÁLIDO>>"
}

Se for contribuir sempre crie e execute os testes:

npm run test

Créditos

Escrito por Vinícius Picanço (viniciusspicanco@gmail.com).
Agradeço a contribuição de:

Downloads/wk

198

GitHub Stars

10

LAST COMMIT

1yr ago

MAINTAINERS

1

CONTRIBUTORS

3

OPEN ISSUES

2

OPEN PRs

8
VersionTagPublished
0.1.1
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial

Rate & Review

100
No reviews found
Be the first to rate