asaas-node
v0.0.8
Published
It is an unofficial integreation with asaas.com Rest API
Downloads
20
Readme
ASAAS-NODE
The project is an unofficial wrapper for the ASAAS.com Rest API. The project is using RxJS, so you must know something about.
Getting Started
To-Do
- [x] Customer API
- [x] Payments Api
- [ ] Subscription Billing
- [x] Notifications
Installing
npm install --save asaas-node
Example
How to use:
const asaas = require('asaas-node');
const api = new asaasAPI('sandbox', YOUR_API_KEY);
/* you can use 'production'
instead of 'sandbox'.
The API_KEI must be from the correct environment.
*/
//Get Customer APIs
const customer = api.customer;
Adding a new customer :
const customerInfo = {
name: 'Bruce Wayne',
cpfCnpj: '37132385615',
email: '[email protected]'
}
customer.new(customerInfo)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
'customerInfo' is an object with all the props that Asaas accepts.
Deleting a customer:
customer.delete(customerId)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
'customerId' is a string.
Getting a customer:
customer.get(cusutomerId)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
Updating a customer:
customerId : the id of the customer
customerInfo: the object with the props to update.
customer.update(customerId, customerInfo)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
Getting List.
customerPropsFilters: the object with the filters props.
customer.getList(customerPropsFilter)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
Payments Examples
The same logic is applied
//Get Payments APIs
const payments = api.payments;
The methods:
payments.new(paymentInfo)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
/* If you need create more than one payment, you can pass an Array<paymentInfo>.
All the response will be in the responseArray.
This pipeline will not generate nothing in (err) for bad request, the error will be
in the responseArray.
*/
payments.newBatch(paymentsInfo)
.subscribe(
(responseArray) => console.log(responseArray)
);
payments.newSplit(paymentInfo, splitInfo)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
payments.get(paymentId)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
payments.delete(paymentId)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
payments.getList(filters)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
payments.update(id, params)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
payments.refund(id)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
Notification
//Get Notification APIs
const notification = api.notification;
notification.get(customerId)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
notification.update(id, params)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);
Accounts
//Get accounts APIs
const accounts = api.accounts;
accounts.new(accountInfo)
.subscribe(
(body) => console.log(body),
(err) => console.log(err)
);