Usage

This guide provides a step-by-step process to integrate your custom API endpoints with Zluri using the Zluri Integration SDK.

Prerequisites

• Knowledge of the data points you wish to sync
• Familiarity with REST APIs

Integration steps

Step 1: Obtain an API key and app ID

Contact your designated Zluri Single Point of Contact (SPOC), and ask for your organization's API key and app ID. We’ll use these for authenticating integration requests with Zluri.

Step 2: Create a New Instance for Org Integration

Initiate a new instance for your organization's integration by invoking the Get Or Create Org Integration API. Zluri will return a UUID (or instance ID) for the instance name and (optionally) app name that you submit in this step.

Step 3: Configure Data Points

Determine which data points you intend to sync. Use the Get Available Data Points API to obtain a list of supported data points.

Step 4: Initiate data sync

With the data points configured, you're ready to begin syncing data to Zluri SDK. Consult our API documentation to start the data sync.

Step 5: Upload data

Invoke the Upload Data API to feed data to Zluri. If required, contact Zluri's support team to obtain the list of supported data point values and data upload format.

Step 6: Finish syncing

Finally, invoke the  Finish Sync API to trigger Zluri's data ingestion pipeline.

Optional step: Map data points (not recommended)

Only if required, you can configure the mapping between your data points and Zluri's expected format. Supported data types in V1 include String, Array, Number, Date, DateTime, and lookup.

Here’s an example mapper configuration:

"sdkdataPointMapper": [
  {
    "from": "firstName",
    "to": "name",
    "dataType": "String",
    "ignoreNull": true},
  {
    "from": "email",
    "to": "email_id",
    "dataType": "String",
    "ignoreNull": true},
  {
    "from": "department",
    "to": "dept",
    "dataType": "lookup",
    "dataTypeConfig": {
      "match": "Department.id",
      "fetch": "Department.value"
    }
  }
]

Get support

Got questions? Feel free to submit a ticket or contact us directly at [email protected].