acquiring-sdk-nodejs
v0.1.0
Published
SDK to communicate with the Worldline Acquiring platform using the Worldline Acquiring API
Downloads
36
Keywords
Readme
Worldline Acquiring Node.js SDK
Introduction
The Node.js SDK helps you to communicate with the Worldline Acquiring API. Its primary features are:
- convenient JavaScript wrapper around the API calls,
- authentication of all calls
- logging support by proxying log calls to a custom user defined logger instance
- validation of input and
- a logfile obfuscater
See the Worldline Acquiring Documentation for more information on how to use the API.
Structure of this repository
This repository consists out of three main components:
- The source code of the SDK itself:
/src
- The JSON schemas used to validate requests:
/schemas
- Unit and integration tests:
/__tests__
Requirements
Node.js 18 or higher is required.
Installation
From the folder where your package.json
is located, run the following command to install the SDK:
npm i acquiring-sdk-nodejs
Building the repository
From the root of the project install all dependencies, then compile the code:
npm install
npm run build
Testing
There are two types of tests:
Unit tests. These will work out-of-the-box.
Run these tests as follows:npm run test:unit
Integration tests. Before you can run these, you first need to copy file
__tests__/config.json.dist
to__tests__/config.json
and replace all values as needed. If needed, aproxy
property can be added with nested propertieshost
,scheme
(defaults tohttp
),port
(defaults to 3128) andcredentials
(optional, in the format<username>:<password>
).
Run these tests as follows:npm run test:integration
You can also run both types of tests together as follows:
npm run test