https://github.com/perusworld/node-qkr-api

Simple Node.js library to interact with Mastercard Qkr! APIs
https://github.com/perusworld/node-qkr-api

Last synced: 5 months ago
JSON representation

Simple Node.js library to interact with Mastercard Qkr! APIs

• Host: GitHub
• URL: https://github.com/perusworld/node-qkr-api
• Owner: perusworld
• Created: 2017-06-22T20:25:25.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2025-12-11T17:54:28.000Z (6 months ago)
• Last Synced: 2025-12-12T22:39:49.982Z (6 months ago)
• Language: TypeScript
• Size: 176 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Simple Node.js library to interact with Mastercard Qkr! APIs #

[![bitHound Overall Score](https://www.bithound.io/github/perusworld/node-qkr-api/badges/score.svg)](https://www.bithound.io/github/perusworld/node-qkr-api)

[![bitHound Dependencies](https://www.bithound.io/github/perusworld/node-qkr-api/badges/dependencies.svg)](https://www.bithound.io/github/perusworld/node-qkr-api/master/dependencies/npm)

[![bitHound Code](https://www.bithound.io/github/perusworld/node-qkr-api/badges/code.svg)](https://www.bithound.io/github/perusworld/node-qkr-api)

If you are looking to call Qkr! APIs via a backend server then head over to [node-qkr-api-server](https://github.com/perusworld/node-qkr-api-server)

## Install ##

```bash

npm install github:perusworld/node-qkr-api --save

```

## Create instance ##

```javascript

var qkr = require('node-qkr-api');

var qkrApi = new qkr.QKRApi({

    publicKey: process.env.QKR_PUBLIC_KEY,

    privateKey: process.env.QKR_PRIVATE_KEY,

    urlPrefix: process.env.QKR_URL

});

```

## Sample Calls (check [test](./test) folder for complete list) ## 

### Get merchants ###

```javascript

qkrApi.getMerchants().then(resp => {

    console.log(JSON.stringify(resp, null, 2));

}).catch(err => {

    console.log(err);

});

```

## Running testcases ## 

- Bash

```bash

export QKR_PUBLIC_KEY="---qkr-public-key---"

export QKR_PRIVATE_KEY="---qkr-private-key---"

export QKR_URL="---qkr-sandbox-or-production-url---"

export QKR_TEST_USER="--test-user--"

export QKR_TEST_PWD="--test-password--"

npm test

```

 - Powershell

```powershell

$env:QKR_PUBLIC_KEY="---qkr-public-key---"

$env:QKR_PRIVATE_KEY="---qkr-private-key---"

$env:QKR_URL="---qkr-sandbox-or-production-url---"

$env:QKR_TEST_USER="--test-user--"

$env:QKR_TEST_PWD="--test-password--"

npm test

```