Overview

Orchestration is a module of a client-side JavaScript SDK that allows you to communicate with Mosaic, run journeys, and submit client input. Contact your Transmit representative to learn more about our orchestration capabilities.

Benefits

The SDK offers the following advantages:

• Abstract and simplify the communication scheme
• Validate that the client input response contains the expected client input
• Keep state between the last server response and the next client input response
• Allow passing the state between pages, for multi-page applications

Installation

Load the SDK:

<script src="https://platform-websdk.transmitsecurity.io/platform-websdk/1.x/ts-platform-websdk.js" id="platform-sdk"></script>

npm install @transmitsecurity/platform-web-sdk@^1

yarn add @transmitsecurity/platform-web-sdk@^1

Initialization

The main module interface is IdoSDK. To initialize activate the following code:

// If SDK was loaded via script tag, use:
// window.tsPlatform.initialize({ ... });
import { initialize } from '@transmitsecurity/platform-web-sdk';

// Initialize the SDK with your client ID and server path
initialize({
  clientId: 'my-client-id',
  ido: {
    serverPath: 'https://api.transmitsecurity.io/ido'
  }
});

For more information, refer to the class reference, as well as the Quick start guides. We also recommend checking out the code samples for the various client side operations under IdoJourneyActionType.