SDK Integration

This section provides detailed information on how to integrate the Netcetera 3DS SDK into an Android Application or Library.

Gradle Setup

As a first step, the Netcetera Android 3DS SDK needs to be declared as dependency to the Application or Library. That can be done using Gradle, via Maven repository or referencing it as local artefact.

Via Maven Repository

The best way of including the 3DS SDK into your Android Application or Library can be done by publishing the AAR and POM files to a private Maven repository.

Once it has been published, in the Application’s or Library’s gradle.build declare dependency on it:

1
2
3
dependencies {
  implementation 'com.netcetera.android-3dssdk:3ds-sdk:2.0.0'
}

Via Local Artefact

To avoid publishing to Maven repository, the AAR artefact can be included as local library to the project. In this case, all the dependencies will need to be adeded manually.

Steps to be performed:

  • Add the provided 3ds-sdk-2.0.0.aar artefact to the libs/ directory of your Application or Library. For example, for Application module named app, this directory would be aap/libs/.
  • Add the Netcetera Android 3DS SDK dependency in the Application or Library build.gradle file:
1
2
3
dependencies {
  implementation files('libs/3ds-sdk-1.0.0.aar')
}
  • Add the external dependencies as described in Dependencies chapter.

Bundling Netcetera 3DS SDK into other Android Library

The Netcetera Android 3DS SDK can be bundled into another Android Library with the purpose of delivering the integration as single artefact to a client.

The Android Gradle Plugin doesn’t yet support official way of bundling an Android Library into another Android Library and there are no reliable third party plugins of performing such operation. The safest option is to do it manually with the steps described.

  1. Extract the Netcetera Android 3DS SDK by renaming the `.aar` artefact to `.zip`.
  2. Move the resulting `classes.jar` into the Android Library module's `libs` folder. Make sure artefacts in the `libs` are included as dependencies.

    Note: The classes.jar contains some additional binaries other than “.class” and will only be packaged correctly in the other library when using Android Gradle Plugin 3.5.0 or greater.

    dependencies {
      implementation fileTree(dir: 'libs', include: ['*.jar'])
    }
    
  3. Move the contents of the `jni` folder into the Android Library module's `src/main/jniLibs/`. Not all native compiled libraries (`.so`) have to be included, only the ones that the integrator Android Library wants to support. For example, `mips` and `armeabi` can be freely excluded since the market share is very low. The final result shall look similar to this:
    .
    └── main
       └── jniLibs
          ├── arm64-v8a
          │   └── <contents from the `jni/arm64v8a`>
          ├── armeabi
          │   └── <contents from the `jni/armeabi`>
          ├── armeabi-v7a
          │   └── <contents from the `jni/armeabi-v7a`>
          ├── mips
          │   └── <contents from the `jni/mips`>
          ├── x86
          │   └── <contents from the `jni/x86`>
          └── x86_64
              └── <contents from the `jni/x84_64`>
    
  4. Add the DS Logos from `res/` into the Android Library drawable resources. The name of the resources have to stay the same in order to be referencable by the Netcetera Android 3DS SDK. Not needed logos can be removed, but the default configuration for the removed DS Logos will not work. Final structure shall look similar to this:
    .
    └─ main
       └── res
           ├── drawable
           │   ├── ds_logo_amex.xml
           │   ├── ds_logo_mastercard.xml
           │   ├── ds_logo_visa.xml
           │   └── <Other Drawable resources>
           └── values
               └── values.xml
    
  5. Add the external dependencies as described in [Dependencies](#Dependencies) chapter.
  6. Copy the proguard rules from `proguard.txt` into your consumer proguard rules.

As a result from all the steps, the Netcetera Android 3DS SDK classes will be able to be used in the integrating Android Library and once it is build, it will be included in the resulting .aar artefact.

License Setup

Configuration with ConfigParameters

To define the license, use the ConfigParameters.addParam(...) with the following arguments:

Argument Value
group null
paramName "license-key"
paramValue The content of the license file.

Example:

1
configParameters.addParam(null, "license-key", "eyJhbGciOiJ...");

Configuration with ConfigurationBuilder (Recommended)

For setting the license the ConfigurationBuilder feature of the Netcetera Android 3DS SDK can be used. This feature provides easier integration and configuration of the SDK.

To define the license use ConfigurationBuilder.license(...) with the following arguments

Argument Value
licenseKey The content of the license file.

Example:

1
ConfigurationBuilder().license("eyJhbGciOiJ...").build();

Android Studio Javadoc Setup

In order for Android Studio to be able to show Javadoc for the API of the Netcetera Android 3DS SDK, it needs to include the 3ds-sdk-javadoc.jar that was delivered as part of the delivery package.

For including, please follow this steps:

  • Open the External Libraries in the Android Studio tree-view
  • Locate the Android Netcetera 3DS SDK library
  • Right click and open Library Properties...
  • Using the ‘+’ button, add the delivered Javadoc. It will be automatically detected as Javadoc type.

Dependencies

Certain external dependencies need to be provided in order for the Netcetera Android 3DS SDK to work as intended. These required dependencies with their exact version are listed in the delivered Maven POM file.

If this SDK was included in the project Via Maven Repository, the gradle build system will include the external dependencies automatically and they don’t need to be included in the build.gradle file. If the SDK is included via local artefact or bundled into other Android library check the Maven pom file for the dependencies that need to be included.

Third-party libraries

The following table contains all the third-party libraries that are used in the Android 3DS SDK.

The libraries that are marked as embedded are pre-bundled into the SDK codebase and therefore not needed to be added as dependencies by the Requestor application. Libraries that are not embedded must be added by the Requestor application as dependencies with the provided obfuscation exception rules.

Name Website Embedded in the SDK License
Apache Commons http://www.apache.org/
Apache 2.0
jose.4.j https://bitbucket.org/b_c/jose4j/
Apache 2.0
Bouncy Castle https://www.bouncycastle.org/
MIT license
Simple Logging Facade for Java https://www.slf4j.org/
MIT license
* Google Play Services Base https://maven.google.com/web/index.html?#com.google.android.gms:play-services-base
Android Software Development Kit License
* AndroidX AppCompat Library https://maven.google.com/web/index.html?#androidx.appcompat:appcompat
Apache 2.0

Dependencies marked with * are optional, however it is strongly recommended that they be included

Code Optimizing and Obfuscating

In order the Netcetera Android 3DS SDK to work as intended, the bytecode of the provided SDK shall not be modified in any way. The simplest way of achieving this is to exclude everything from optimization and obfuscation in the com.netcetera.threeds.sdk package.

Besides configuring the optimization and obfuscation for the SDK, a configuration optimization and obfuscation for the dependencies of the SDK shall be added. A configuration for each dependency that is not embedded in the SDK shall be added. Use the table above to check which dependencies are embedded in the SDK.

Sample Proguard configuration can be found in the Netcetera Demo Merchant and the source code of it.