Getting Started with SDKs
The following sections can help you to get started with OneSpan Sign's SDKs:
- SSL Communication
- Integration Environment
- OneSpan Sign Java SDKs
- OneSpan Sign .NET SDKs
- OneSpan Sign APEX SDK
SSL Communication
Integration with OneSpan Sign is secured via an SSL certificate issued by GlobalSign. Thus that GlobalSign intermediate certificate must be installed in your integration environment.
While you can add any of the certificates in the certificate chain, the Root-CA certificate should work for most environments.
Integration Environment
In light of the Logjam security vulnerability, OneSpan Sign has increased its DH SSL key from 1024 bits to 2048 bits.
Older versions of Java and .NET will no longer be able to connect to OneSpan Sign, since they don't support the larger encryption key.
Certificate Details
Certificate serial#: 04 00 00 00 00 01 21 58 53 08 a2 Thumbprint: d6 9b 56 11 48 f0 1c 77 c5 45 78 c1 09 26 df 5b 85 69 76 ad
Download link: https://secure.globalsign.net/cacert/Root-R3.crt
OneSpan Sign Java SDKs
Our Java SDKs enable integration with any application written in the Java programming language.
By default, the .NET and Java SDKs are not thread-safe. If you are running this code in a multi-threaded application, you may encounter race conditions and deadlocks. As such, we recommend that each thread have its own instance of the SDK.
Minimum Requirements
Your JVM must be using Java 1.7.0_21 or higher.
To identify the Java version installed on your system, run the following command:
java -version
If you want to work with an OneSpan Sign Java SDK, download the 11 version.
To view Javadoc documentation for an OneSpan Sign Java SDK, use the following procedure:
Navigate to our OneSpan Sign MVN Repository, located here: https://mvnrepository.com/artifact/com.silanis.esl/sdk
Select the SDK Version you would like to see documentation for. For example, 11.45.
In the Files row, click View All.
Download and unzip the following file: sdk-<version number>-javadoc.jar
The OneSpan Sign Java SDKs support Java 1.7_21 and higher.
For additional information, see the GitHub examples below.
Downloading the latest SDK 11 version
-
To download the OneSpan Sign .JAVA SDK, click here.
To view Javadoc documentation for a OneSpan Sign Java SDK version, use the following procedure:
Navigate to our OneSpan Sign MVN Repository, located here: https://mvnrepository.com/artifact/com.silanis.esl/sdk
Select the SDK version you would like to see documentation for. For example, 11.45.
In the Files row, click View All.
Download and unzip the following file: sdk-<version number>-javadoc.jar
Installing
To see if this certificate is already installed in your environment, run the following command:
keytool -list -keystore <JAVA_HOME/lib/security/cacerts> | grep -i d6:9b:56:11:48:f0:1c:77:c5:45:78:c1:09:26:df:5b:85:69:76:ad
If the certificate is not installed, install it by running the following command:
keytool -importcert -alias GlobalSignRootCAR3 -keystore <JAVA_HOME/lib/security/cacerts> -file Root-R3.crt
Sample Java Code
Maven Users
If you are a Maven user, add to your pom file the appropriate one of following dependencies.
For SDK 11:
<dependency> <groupId>com.silanis.esl</groupId> <artifactId>sdk</artifactId> <version>11.xx</version> <classifier>jar-with-dependencies</classifier> </dependency>
If you want the version of the SDK that bundles all dependencies, add <classifier>jar-with-dependencies</classifier>
to the dependency.
OneSpan Sign .NET SDKs
Our .NET SDKs enable integration with any application written in the C# programming language.
If you want to work with an OneSpan Sign .NET SDK, download the 11 version, and perform the extra configuration described below. For additional information, see the GitHub examples below.
By default, the .NET and Java SDKs are not thread-safe. If you are running this code in a multi-threaded application, you may encounter race conditions and deadlocks. As such, we recommend that each thread have its own instance of the SDK.
Minimum Requirements
.NET
We now support .NET Standard 2.0 and .NET framework 4.5 or higher. This means that .NET Core is also supported, and that Linux machines can also be used.
To identify the .NET framework installed on your system, follow the instructions in this link: https://msdn.microsoft.com/en-us/library/hh925568
SDK 11
-
To download the OneSpan Sign .NET SDK, click here.
Installing
To install the certificate, double-click the file Root-R3.crt
, and then select install certificate.
Sample .NET Codes
OneSpan Sign APEX SDK
Written in APEX, the OneSpan Sign APEX SDK for Salesforce enables developers to integrate e-signing functionality into their custom apps on either Salesforce or the Force.com platform.
- To get started, please download the OneSpan Sign APEX SDK on GitHub.
- You can also view numerous code snippets and examples.
- If you have specific questions, check out our Developer Forums.