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 Maven (recommended)

add this to your  pom.xml file

<dependency>
  <groupId>io.secuconnect</groupId>
  <artifactId>secuconnect-java-sdk</artifactId>
  <version>1.2.1</version>
</dependency>
<repositories>
  <repository>
    <id>secuconnect-java-sdk-mvn</id>
    <url>https://raw.github.com/secuconnect/secuconnect-java-sdk/mvn-repo/</url>
  </repository>
</repositories> 

and then install in using maven :

mvn install

Installing the SDK from downloaded JAR file

On our GitHub-Release-Page you can find a list of JAR files for every release: https://github.com/secuconnect/secuconnect-java-sdk/releases

We are providing f.e. one JAR file with all dependencies.

1) Download the secuconnect-java-sdk-1.2.1-shaded.jar from the github release page https://github.com/secuconnect/secuconnect-java-sdk/releases  and store it into the subdirectory "lib" in your project.

2) add this to your pom.xml :

  <dependency>
    <groupId>io.secuconnect</groupId>
    <artifactId>secuconnect-java-sdk</artifactId>
    <version>1.2.1</version>
    <scope>system</scope>
    <systemPath>${basedir}/lib/secuconnect-java-sdk-1.2.1-shaded.jar</systemPath>
  </dependency>

Installing the SDK using Git

SDK is also available through github on https://github.com/secuconnect/secuconnect-java-sdk

you clone in using:

git clone https://github.com/secuconnect/secuconnect-java-sdk.git

you can also download the project in a zip file from  https://github.com/secuconnect/secuconnect-java-sdk 

1) just clicking on "Clone or download" button


2) and then on "Download Zip" button


Running tests included in SDK

Tests are written in JUnit. To run tests please press run button from options in your IDE.

Exists second option to run tests. It is from command line like below:

mvn clean test


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