Integrate the Image Generator SDK

Prev Next

Android

Maven-based integration

The SDK artifact is also delivered as a local Maven repository with transitive dependencies, and the package includes a documentation jar file to view the technical documentation in Android Studio (to be used in conjunction with the Maven repository).

To integrate the SDK via maven repository:

  1. Copy the maven folder from the published artifacts to the root folder of your application.

  2. Define the dependency in your build.gradle file: implementation 'com.onespan:sdk_image_generator_java:+', implementation 'com.onespan:sdk_utilities_java:+'.

  3. Comment out any existing definitions, for example: implementation(name: 'ImageGeneratorSDK', ext: 'jar'), implementation(name: 'UtilitiesSDK', ext: 'jar').

Java

The following procedure allows you to integrate and use the OneSpan Image Generator SDK in your Java project.

To use the OneSpan Image Generator SDK in your Java project

  1. Link ImageGeneratorSDK.jar from the OneSpan Mobile Security Suite package to your project’s classpath.

  2. Link UtilitiesSDK.jar from the OneSpan Mobile Security Suite package to your project’s classpath.

    To use the Image Generator SDK library, you also need to add the following external libraries to your project:

    dependencies {
    implementation 'org.bouncycastle:bcprov-jdk18on:1.85.2'
    }

You are now ready to use the OneSpan Image Generator SDK.

.NET

The following procedure allows you to integrate and use the OneSpan Image Generator SDK in your .NET project.

To use the OneSpan Image Generator SDK in your .NET project

  1. Add a reference to ImageGeneratorSDK.dll from the OneSpan Mobile Security Suite package to your project.

  2. Add a Nuget package reference to SkiaSharp version 2.88.3.

  3. Add a Nuget package reference to ZXing.Net version 0.16.8.

You are now ready to use the OneSpan Image Generator SDK.

API reference documentation and sample applications

To learn more about the public APIs and their functions, exceptions, and error codes, refer to the technical documentation that is included in the product package for each SDK and each platform. In the product package, you can also find the sample applications provided for each platform to see examples of how the SDKs can be used.

These sample apps are intended only to demonstrate basic scenarios and SDK usage. They are not designed to be copied directly into production projects!