Skip to content

Overview

The Orchestration SDK for Android allows your mobile application to communicate with Mosaic, run journeys, and submit client input. It abstracts the communication protocol and manages state between the client and server throughout a journey's lifecycle.

Capabilities

  • Start and manage journeys from the client side
  • Handle journey steps and submit client responses
  • Maintain state between server responses and client input
  • Support for client-facing journey steps

Requirements

  • Android 5+ (API level 21+)

Installation

Add the Mosaic Maven repository to your project's settings.gradle file:

dependencyResolutionManagement {
    repositories {
        maven {
            url('https://transmit.jfrog.io/artifactory/transmit-security-gradle-release-local/')
        }
        mavenCentral()
        google()
    }
}

Add the SDK dependency to your module's build.gradle file:

dependencies {
    implementation("com.ts.sdk:identityorchestration:1.+")
}

Initialization

The SDK can be initialized using either a strings.xml configuration or SDK parameters.

Add your credentials to strings.xml:

<resources>
    <!-- Mosaic Credentials -->
    <string name="transmit_security_client_id" translatable="false">[YOUR_CLIENT_ID]</string >
    <string name="transmit_security_base_url">[YOUR_BASE_URL]</string>  <!-- Default is https://api.transmitsecurity.io-->
</resources>

Initialize the SDK in your Application class:

try {
    TSIdo.initializeSDK(application_context)
} catch (exception: TSIdoInitializeException) {
    // Handle initialization error
}

Configure the base server URL based on your region:

RegionBase URL
UShttps://api.transmitsecurity.io/
EUhttps://api.eu.transmitsecurity.io/
Canadahttps://api.ca.transmitsecurity.io/
Australiahttps://api.au.transmitsecurity.io/
Japanhttps://api.gasne1-ts01.transmitsecurity.io/
Sandboxhttps://api.sbx.transmitsecurity.io/
Custom domainhttps://<your-domain>.com/ (see Custom domains)

Next steps