Skip to content
This repository has been archived by the owner on Aug 21, 2020. It is now read-only.

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MunifTanjim committed Aug 21, 2020
1 parent d4f777c commit cfefd8a
Showing 1 changed file with 29 additions and 11 deletions.
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ bKash API client for Browser & Node.js

bKash API docs: https://developer.bka.sh/v1.0.0-beta/reference

---

## NOTICE

**bKash used to publish OpenAPI Specification for their API on the [bKash-developer/openapi](https://github.com/bKash-developer/openapi) repository.**

**Which they decided to remove, for reasons I can't imagine.**

**As this library was created based on that specification, it is now outdated.**

**If anybody from bKash (who's related to the decision to unpublish the specification) sees this,**
**if you care about developer experience I urge you to reconsider that decision.**

---

## Installation

via **npm**:
Expand Down Expand Up @@ -42,14 +57,17 @@ const clientOptions = {
const bkash = new BKash(clientOptions)

// https://developer.bka.sh/v1.0.0-beta/reference#querypaymentusingget
bkash.queryPayment({
paymentID: '42'
}).then(({ data, error, headers, meta }) => {
// data -> HTTP Status Code < 400
// error -> HTTP Status Code >= 400
}).catch(err => {
// HTTP Status Code >= 500
})
bkash
.queryPayment({
paymentID: '42'
})
.then(({ data, error, headers, meta }) => {
// data -> HTTP Status Code < 400
// error -> HTTP Status Code >= 400
})
.catch(err => {
// HTTP Status Code >= 500
})
```

## Authentication
Expand All @@ -59,14 +77,14 @@ bkash.queryPayment({
bkash.authenticate({
type: 'simple',
username: '...', // headers[`username`]
password: '...' // headers[`password`]
password: '...' // headers[`password`]
})

// required for all other methods
bkash.authenticate({
type: 'token',
token: '...', // headers[`authorization`]
appkey: '...' // headers[`x-app-key`]
token: '...', // headers[`authorization`]
appkey: '...' // headers[`x-app-key`]
})
```

Expand Down

0 comments on commit cfefd8a

Please sign in to comment.