SDK Integration

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.

Bundling Netcetera 3DS SDK into another Android Library

The Netcetera Android 3DS SDK can be bundled into another Android Library with the purpose of delivering the integration as a 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.

3. Move the contents of the `jni` folder into the Android Library module's `src/main/jniLibs/`. The final result shall look similar to this:

   .
   └── main
      └── jniLibs
         ├── arm64-v8a
         │   └── <contents from `jni/arm64-v8a`>
         ├── armeabi-v7a
         │   └── <contents from `jni/armeabi-v7a`>
         ├── x86
         │   └── <contents from `jni/x86`>
         └── x86_64
             └── <contents from `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
          └── raw
              └── keep.xml
   

5. Move the contents of the `assets` folder into the Android Library module's `src/main/assets/`. Ensure that the folder structure and the name of the assets remain the same in order to be referencable by the Netcetera Android 3DS SDK. The final result shall look similar to this:

   .
   └── main
       └── assets
           └── com
               └── netcetera
                   └── threeds
                       └── sdk
                           └── infrastructure
                               └── <contents from `assets/com/netcetera/threeds/sdk/infrastucture`>
   
   

6. Add the external dependencies as described in Dependencies chapter.
7. 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.

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 these 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.

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.

Below are some popular obfuscation tools and the rules with which they need to be configured in order for the Netcetera Android 3DS SDK to function properly.

Integration in Hybrid Frameworks

This section details the integration of the 3DS SDK Android library into hybrid frameworks. The primary goal is to provide support for numerous applications already utilizing these frameworks. Integration is performed in a manner similar to other native Android libraries, though awareness of potential limitations specific to each hybrid framework is crucial.

Our testing efforts have been focused on two widely used hybrid frameworks: Flutter and React Native. The subsequent sections provide guidance on integrating the library.