Integrate the DSAPP Client SDK

Prev Next

The following procedures outline the steps to integrate the DSAPP Client SDK. For an overview of DSAPP SDK functions and a description of the activation process with DSAPP, see Workflow for the activation process with the DSAPP SDK.

Android

AAR artifact-based integration

To integrate the DSAPP Client SDK into your Android project via aar file

  1. Add DSAPP_Client.aar from the OneSpan Mobile Security Suite package to your project.

  2. Add UtilitiesSDK.aar from the OneSpan Mobile Security Suite package to your project.

  3. In the dependencies section of your build.gradle file, add the implementation("org.bouncycastle:bcprov-jdk18on:1.81") dependency.

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_dsapp_client_android:+'.

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

C++ (iOS)

To use the DSAPP Client SDK in your iOS project

  1. Link MSSDSAPPClient.xcframework from the OneSpan Mobile Security Suite package to your Xcode project (linked framework and libraries).

  2. Link UtilitiesSDK.xcframework from the OneSpan Mobile Security Suite package to your Xcode project (linked framework and libraries).

Consider the following integration notes:

  • Your project must be compiled with the libc++ standard library!

  • When implementing a new Xcode project, you may see an Objective-C error that says Reference to 'byte' is ambiguous. The solution is to update the project Build Settings and change the C++ Language Dialect to Compiler Default.

  • The DSAPP SDK Client C++ headers no longer declare using namespace std;. If your code relied on it, you may see errors such as unknown type name 'string' or use of undeclared identifier 'cout'. Update your code and use the std:: prefix (for example std::string) or add using namespace std;.

You are now ready to use the DSAPP Client 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!