Skip to content

Commit d95d4da

Browse files
iamchriswickiamchriswick
committed
patch
1 parent efca2aa commit d95d4da

1 file changed

Lines changed: 37 additions & 56 deletions

File tree

‎README.md‎

Lines changed: 37 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,30 @@
11
# Node.js SDK for connecting to the Settle Payment Platform
22

33
[![License](https://img.shields.io/badge/license-Apache%202-brightgreen.svg)](https://github.com/SettleAPI/settle-sdk-node/blob/master/LICENSE)
4-
[![Build Status](https://travis-ci.com/SettleAPI/settle-sdk-node.svg?branch=master)](https://travis-ci.com/SettleAPI/settle-sdk-node) [![dependencies Status](https://david-dm.org/SettleAPI/settle-sdk-node/status.svg)](https://david-dm.org/SettleAPI/settle-sdk-node) [![devDependencies Status](https://david-dm.org/SettleAPI/settle-sdk-node/dev-status.svg)](https://david-dm.org/SettleAPI/settle-sdk-node?type=dev)
4+
[![Build Status](https://travis-ci.com/SettleAPI/settle-sdk-node.svg?branch=master)](https://travis-ci.com/SettleAPI/settle-sdk-node)
55

66
**Start accepting payments via Settle in seconds** ✨
77

88
An easy to use **SDK** for **Node.js** with all the best practices to kickstart your integration with the **Settle Payment Platform**.
99

1010
## Features
1111

12-
This SDK is divided into two parts:
13-
14-
* **Client** - Simplifies calling the Settle APIs by handling signing and authorization.
15-
* **Handler** - [Express.js](https://expressjs.com/) compatible middleware that verifies signatures of incoming callbacks from Settle.
16-
17-
## Client Functions
18-
19-
### Merchant API - Available Now
20-
- [merchant.api_keys](https://settle.dev/api/reference/rest/v1/merchant.apiKeys/)
21-
- [merchant.balance](https://settle.dev/api/reference/rest/v1/merchant.balance/)
22-
- [merchant.logo](https://settle.dev/api/reference/rest/v1/merchant.logo/)
23-
- [merchant.payment.request](https://settle.dev/api/reference/rest/v1/merchant.payment.request/)
24-
- [merchant.payment.request.outcome](https://settle.dev/api/reference/rest/v1/merchant.payment.request.outcome/)
25-
- [merchant.payment.send](https://settle.dev/api/reference/rest/v1/merchant.payment.send/)
26-
- [merchant.payment.send.outcome](https://settle.dev/api/reference/rest/v1/merchant.payment.send.outcome/)
27-
- [merchant.pos](https://settle.dev/api/reference/rest/v1/merchant.pos/)
28-
- [merchant.profile](https://settle.dev/api/reference/rest/v1/merchant.profile/)
29-
- [merchant.sales.summary](https://settle.dev/api/reference/rest/v1/merchant.sales.summary/)
30-
- [merchant.settlement](https://settle.dev/api/reference/rest/v1/merchant.settlement/)
31-
- [merchant.settlement.account](https://settle.dev/api/reference/rest/v1/merchant.settlement.account/)
32-
- [merchant.settlement.latest](https://settle.dev/api/reference/rest/v1/merchant.settlement.latest/)
33-
- [merchant.settlement.report](https://settle.dev/api/reference/rest/v1/merchant.settlement.report/)
34-
- [merchant.shortlink](https://settle.dev/api/reference/rest/v1/merchant.shortlink/)
35-
- [merchant.statusCodes](https://settle.dev/api/reference/rest/v1/merchant.statusCodes/)
36-
37-
### OAuth 2.0 Authorization Framework - Coming Soon
12+
### This SDK is divided into two parts:
3813

39-
- [oauth2.auth.code](https://settle.dev/api/reference/rest/v1/oauth2.auth.code/)
40-
- [oauth2.auth.request](https://settle.dev/api/reference/rest/v1/oauth2.auth.request/)
41-
- [oauth2.auth.token](https://settle.dev/api/reference/rest/v1/oauth2.auth.token/)
42-
- [oauth2.error](https://settle.dev/api/reference/rest/v1/oauth2.error/)
43-
- [oauth2.qrImage](https://settle.dev/api/reference/rest/v1/oauth2.qrImage/)
44-
- [oauth2.user.info](https://settle.dev/api/reference/rest/v1/oauth2.user.info/)
14+
* **Client** — Simplifies calling the Settle API by handling request signing and authorization.
15+
* **Handler** — [Express.js](https://expressjs.com/) compatible middleware that verifies signatures of incoming callbacks from Settle.
4516

46-
### Permissions API - Coming Soon
47-
- [users.permissions](https://settle.dev/api/reference/rest/v1/users.permissions/)
48-
- [users.permissions.request](https://settle.dev/api/reference/rest/v1/users.permissions.request/)
49-
- [users.permissions.request.outcome](https://settle.dev/api/reference/rest/v1/users.permissions.request.outcome/)
50-
- [users.permissions.scope](https://settle.dev/api/reference/rest/v1/users.permissions.scope/)
17+
## Usage
5118

19+
### Step 1 — Install the SDK
5220

53-
## Installation
21+
Add the `settle-sdk-node` NPM package to you project.
5422

55-
`npm i settle-sdk-node`
23+
```bash
24+
npm i settle-sdk-node
25+
```
5626

57-
## Config
27+
### Step 2 — Configure the SDK
5828

5929
In your projects **root folder**, create a file named `config.js` containing the following code:
6030

@@ -76,15 +46,24 @@ module.exports = {
7646
}
7747
```
7848

79-
## Usage
49+
### Step 3 — Initialize the Handler Function
8050

81-
```js
82-
merchant.api_keys.list().then(success, failure)
51+
```js title="Handler Example"
52+
const { handler } = require('settle-sdk-node')
53+
app.use(handler('sandbox'))
54+
app.post( '/', ( req, res, next ) => {
55+
console.log( 'Settle says:\n%s', req.body );
56+
res.sendStatus( 200 );
57+
});
8358
```
8459

85-
## Client Example
60+
### Step 4 — Using Client Functions
8661

87-
```js
62+
```js title="Basic Client Function usage"
63+
method.function().then(success, failure)
64+
```
65+
#####
66+
```js title="List all API Keys Example"
8867
const settle = require('settle-sdk-node');
8968
const merchant = settle.merchant;
9069

@@ -96,21 +75,23 @@ merchant.api_keys.list()
9675
});
9776
```
9877

99-
## Handler Example
78+
> For a full overview of all available **Client Functions**, see our article on [how to use Client Functions in the Settle SDK for Node.js](./ZG9jOjM0ODQwMjA4-using-the-client-functions).
79+
80+
81+
<!-- ### OAuth 2.0 Authorization Framework - Coming Soon
82+
83+
- [oauth2.auth.code](https://settle.dev/api/reference/rest/v1/oauth2.auth.code/)
84+
- [oauth2.auth.request](https://settle.dev/api/reference/rest/v1/oauth2.auth.request/)
85+
- [oauth2.auth.token](https://settle.dev/api/reference/rest/v1/oauth2.auth.token/)
86+
- [oauth2.error](https://settle.dev/api/reference/rest/v1/oauth2.error/)
87+
- [oauth2.qrImage](https://settle.dev/api/reference/rest/v1/oauth2.qrImage/)
88+
- [oauth2.user.info](https://settle.dev/api/reference/rest/v1/oauth2.user.info/) -->
10089

101-
```js
102-
const { handler } = require('settle-sdk-node')
103-
app.use(handler('sandbox'))
104-
app.post( '/', ( req, res, next ) => {
105-
console.log( 'Settle says:\n%s', req.body );
106-
res.sendStatus( 200 );
107-
});
108-
```
10990

11091
## Open Source and Contribution
11192

11293
The **SDK** is **Open Source**, licensed under the **Apache 2** license. If you would like to **contribute** to the **SDK**, please feel free to **fork the repo and send us a pull request**. Or if you have a comment, question, or suggestion for improvements, please [raise an issue](https://github.com/SettleAPI/settle-sdk-node/issues).
11394

11495
### License
115-
[Apache 2](https://github.com/SettleAPI/settle-sdk-node/blob/master/LICENSE) © [Settle Group](https://settle.eu/) / [Christian Wick](mailto:christian@settle.eu)
96+
[Apache 2](https://github.com/SettleAPI/settle-sdk-node/blob/master/LICENSE) © [Settle Group](https://settle.eu/) / [Christian Wick](https://github.com/iamchriswick)
11697

0 commit comments

Comments
 (0)