Introduction

The secuconnect API is our REST API that gives you access to manage payments, loyalty card transactions, and all the other good thing we provide.

Our secuconnect SDKs help you to ease the access to the secuconnect API. SDK stands for “Software Development Kit” and provide a set of tools, libraries, relevant documentation, code samples, processes and/or guides that developers allow to create software applications on a specific platform. More

This guide is to use our SDK to quickly connect and manage all kind of transactions did in secupay. The following Getting Started section will help you to install our SDK and to make your first payment transaction at secupay.

Our SDKs are generated by using the Swagger/OpenAPI 2.0 annotation. We also provide this here (https://github.com/secuconnect/oas-spec) and you can use it to write your own client for the secuconnect API if you wish so.

Getting Started

Installing the SDK using NPM (recommended)

#TODO: Write npm section when npm entry is made.

NPM will manage SDK dependencies on it's own. However if you install SDK by ZIP, or git, it's up to you to download all those dependencies. package.json contain list of all needed dependencies.

Installing the SDK from downloaded ZIP file

#TODO: Write zip section when repo and url to master's zip is available.

Installing the SDK using Git

#TODO: Write  git section when git repo url is available

Running tests included in SDK

SDK comes with JS tests for some use cases. You can run tests with following command:

npm install
npm test

Configuration

#TODO: Write configuration section, when cache is implemented in SDK

Authentication

See Authentication section to learn about authentication options, requirements and working example.

A sample application

See sample application section for robust example of authentication, SDK configuration and CRUD use case.