# Orchestration quickstart: Android SDK This guide describes how to quickly integrate Journeys into your Android application. See SDK reference ## Introduction The Orchestration SDK enables client-side developers to build user experiences that interact with Client SDK journeys. Each journey contains a business workflow, such as login or secure user onboarding. It consists of backend steps, such as data processing or invoking external systems, and client-facing steps, such as a login form or identity verification. The SDK allows the client application to present screens and prompt for user input, and then send this information back to the journey for further processing. Whenever the client-side interaction requires additional Mosaic platform capabilities, such as passkeys or risk detection, the developer needs to activate the appropriate SDK module to perform the step and collect the required input. This allows separation of concerns between the journey workflow handling, and the specific capability used. This guide will use the "Hello World" journey template and instruct you how to build a client side application that works with it. Here is a short video that describes this journey, and how a sample web application interacts with it. ## Requirements - Android 5+ (API level 21+) ## Before you start Before the SDK can start running journeys, make sure to: - Create a journey for this tutorial. In the Admin Portal, go to **B2C** or **B2B Identity** (based on your setup) > **Journeys**. From there click on **Templates**, and choose the **Level 0 tutorials / Hello world** template. Click to create a journey from this template. Set the name to `hello-world-quickstart` and save the journey ID - Create an application and obtain the auto-generated Client ID as defined [here](/guides/user/create_new_application) - Allow Mosaic IPs and [domains](/guides/quick_start/enable_communication) on your network (if using a [custom domain](/guides/deployment/custom_domains), configure your network accordingly) - Extend the `Content-Security-Policy` header, if [CSP](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) is enabled on your web server (if using a [custom domain](/guides/deployment/custom_domains), update your CSP to include your custom domain) ## Step 1: Load SDK Add the following lines in the shared build.gradle file ("allprojects" scope): ```groovy dependencyResolutionManagement { repositories { maven { url('https://transmit.jfrog.io/artifactory/transmit-security-gradle-release-local/') } mavenCentral() google() } } ``` Add the following in the module build.gradle file (project scope): ```groovy dependencies { implementation("com.ts.sdk:identityorchestration:1.+") } ``` ## Step 2: Initialize SDK Initializing the SDK configures it to work with your client ID, which is the context under which the entire journey is executed. It also allows setting the base URL for the SDK to use, whether a Mosaic-provided path or your own proxy. details summary b Initialize using strings.xml configuration (recommended) To do this, update the strings.xml file in your Application with the following content. ```xml [YOUR_CLIENT_ID] [YOUR_BASE_URL] ``` Add this code to initialize the SDK: ```kotlin // Initializes SDK where application_context is an object inheriting from Application class try { TSIdo.initializeSDK(application_context) } catch (exception: TSIdoInitializeException) { // log error… } ``` Note If you're using a [custom domain](/guides/deployment/custom_domains) for your application, set `transmit_security_base_url` to your custom domain instead of the default Transmit domain. details summary b Initialize using SDK parameters Configure the SDK using the snippet below: ```kotlin // Initializes SDK where application_context is an object inheriting from Application class TSIdo.initializeSDK(application_context, clientId, TSIdoInitOptions(baseUrl)) // Default is https://api.transmitsecurity.io ``` Note If you're using a [custom domain](/guides/deployment/custom_domains) for your application, use your custom domain as the `baseUrl` instead of the default Transmit domain. ## Step 3: Start journey Starting a journey is usually a response to some user interaction, such as clicking a login or sign-up button. Your application should present a button and call the below on user click. Note we use the name we provided for the journey we created from the template: ```kotlin // Starts a journey "hello-world-quickstart" TSIdo.startJourney("JOURNEY_ID", // Replace with hello-world-quickstart journey ID TSIdoStartJourneyOptions(additionalParams, // Optional additional params flowId), idoCallback) ``` Note The `idoCallback` object should implement the [TSIdoCallback](https://transmitsecurity.github.io/ido-android-api-reference/-identity%20-orchestration%20-s-d-k/com.transmit.idosdk/-t-s-ido-callback/index.html) interface. ## Step 4: Handle service response After starting the journey, the client app waits for the `IdoServiceResponse`. It will contain all the information the client needs in order to determine what to do next. To handle the service response, the client app needs to: 1. [Select a handler based on the step](#1-select-handler) 2. [Implement the hello world form handler](#2-implement-the-hello-world-form-handler) 3. [Implement the display information step handler](#3-implement-the-display-information-handler) ### 1. Select handler Upon receiving the `IdoServiceResponse`, launch a handler that executes the relevant step by switching/selecting on the `IdoServiceResponse.journeyStepId` parameter. In the `hello-world-quickstart` journey we created, there are two steps that we will have to handle: 1. A [Collect information](/guides/orchestration/journeys/get_info_from_client) step. This step expects the client side to collect some data and send back. The step is configured with the Step ID property set to `hello_world_form`. This will be the value inside the `journeyStepId` attribute. 2. A [Display Information](/guides/orchestration/journeys/display_information) step that sends presentable text based data collected from the first step. This will have a fixed ID, so the value inside the `journeyStepId` is `IdoJourneyActionType.Information`. 3. Add handlers for **Success** and **Rejection** completions Each handler will process the data, display whatever UI is needed, and call `submitClientResponse()` when the interaction is concluded, more on this in the next sections. This is how the app code would dispatch the above handlers: ```kotlin when(idoResponse.journeyStepId) { TSIdoJourneyActionType.Information.type -> handleInformationAction(idoResponse) "hello_world_form" -> handleHelloWorldForm(idoResponse) TSIdoJourneyActionType.Success.type -> handleSuccessfulCompletion(idoServiceResponse) TSIdoJourneyActionType.Rejection.type -> handleRejection(idoServiceResponse) } ``` ### 2. Implement the Hello World form handler The following handler is used to collect information from the user as described in [Collect information](/guides/orchestration/journeys/get_info_from_client) step documentation. Specifically, the Hello world form handler should allow the user to enter two strings that should be sent back as `username` and `password`. This matches the expected schema as you can see in the journey's **Collect information** step, under **Schema** field configuration: ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string", "format": "password" } } } ``` You need to display a form that collects these fields, and on user submit sent back to Mosaic as demonstrated below. Note the response type `ClientInput` is standard for almost all journey steps: ```kotlin // display form to user and collect the required values data class HelloWorldData(val username: String, val password: String) ... let idoResponse = TSIdo.submitClientResponse( TSIdoClientResponseOptionType.ClientInput.type, HelloWorldData(collectedUserName, collectedPassword) ) ``` NOTE The resulting `idoResponse` should be looped back to the handler selection code described in the [select handler](#1-select-handler) section above. This response, in our example, will contain the data for displaying the information screen as discussed in the next section. ### 3. Implement the Display Information handler The **Display Information** step is used to display an information screen, as described in the [Display Information](/guides/orchestration/journeys/display_information) step guide. Your handler code should show a screen that displays the information sent from the server, using the `data` property provided in the `idoServiceResponse` object. The specific structure of the data that will be sent for this step is described below, as well as in the step guide. Note that in our journey, the `text` attribute will contain data collected from the user in the previous step: ```json { "data": { "title": "Collected client information", "text": "Here is what we got from the client side: {...}", "button_text": "OK" } } ``` The above data is exposed and used as seen here: ```kotlin val title = (result.data as JSONObject).optString("title") val text = (result.data as JSONObject).optString("text") val buttonText = (result.data as JSONObject).optString("button_text") // display UI based the above, and on button click call the the below let idoResponse = TSIdo.submitClientResponse( TSIdoClientResponseOptionType.ClientInput.type ) ``` NOTE The resulting `idoResponse` should be looped back to the handler selection code described in the [select handler](#1-select-handler) section above. This response, in our example, will contain successful completion as described in the next section. ## Step 5: Complete journey Mosaic signals journey completion by setting the `journeyStepId` property to `Rejection.type` or `Success.type`. The specific enum for each SDK is described in the [select handler](#1-select-handler) above. In this example, we expect a successful response. For authenticated journeys, successful completion can return an opaque code that your client passes to your backend. Your backend then exchanges that code for user tokens and enriched context, allowing it to establish a session, call downstream services, or run additional business logic with the authenticated user context. For details, see [Journey completion for SDK journeys](/guides/orchestration/getting-started/journey_completion). ## Next steps You can now proceed to read the in-depth [Android SDK guide](/guides/orchestration/sdk/android_sdk_guide). style section article ol li { margin-top: 6px !important; } .lifecycleSteps { line-height: 30px !important; }