How to use Destination SDK to configure your destination

IMPORTANT
  • This feature is in limited beta and is only available to select Adobe Exchange members. If you are interested in using Destination SDK, please contact Adobe Exchange.
  • The documentation and the functionality are subject to change.

Overview

This page describes how to use the reference information in Configuration options for the Destinations SDK to configure your destination using Destination SDK. The steps are laid out in sequential order below.

Prerequisites

Before advancing to the steps illustrated below, please read the Destination SDK getting started page for information on obtaining the necessary Adobe I/O authentication credentials and being added to an allowed list.

Use the Configuration options in Adobe Experience Platform Destination SDK to set up your destination

Illustrated steps of using Destination SDK endpoints

Step 1: Create a server and template configuration

Start by creating a server and template configuration using the /destinations-server endpoint (read API reference). For more information about the server and template configuration, refer to Server and template specs in the reference section.

Shown below is an example configuration. Note that the message transformation template in the requestBody.value parameter is addressed in step 3, Create transformation template.


POST platform.adobe.io/data/core/activation/authoring/v1/destination-servers

{
  "name": "Moviestar destination server",
  "destinationServerType": "URL_BASED",
  "urlBasedDestination": {
    "url": {
      "templatingStrategy": "PEBBLE_V1",
      "value": "https://api.moviestar.com/data/{{endpoint.region}}/items"
    },
    "maxUsersPerRequest": 100,
    "splitUserById": true
  }
},
  "httpTemplate": {
    "httpMethod": "POST",
    "requestBody": {
            "templatingStrategy": "PEBBLE_V1",
            "value": "insert after you create a template in step 3"
        },
        "contentType": "application/json"
    }

Step 2: Create destination configuration

Shown below is an example configuration for a destination template, created by using the /destinations API endpoint. For more information about this template, refer to Destination configuration.


POST platform.adobe.io/data/core/activation/authoring/v1/destinations
 
{
  "name": "Moviestar",
  "description": "Moviestar is a fictional destination, used for this example.",
  "releaseNotes": "Test release",
  "status": "TEST",
  "customerAuthenticationConfigurations": [
    {
      "authType": "BEARER"
    }
  ],
  "customerDataFields": [
      {
        "name": "endpointsInstance",
        "type": "string",
        "title": "Select Endpoint",
        "description": "Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
        "isRequired": true,
        "enum": [
          "US",
          "EU",
          "APAC",
          "NZ"
        ]
      },
      {
      "name": "customerID",
      "type": "string",
      "title": "Moviestar Customer ID",
      "description": "Your customer ID in the Moviestar destination (e.g. abcdef).",
      "isRequired": true,
      "pattern": ""
      }
    ],
  "uiAttributes": {
    "documentationLink": "http://www.adobe.com/go/destinations-moviestar-en",
    "category": "mobile",
    "iconUrl": "https://address-to-your-logo.png",
    "connectionType": "Server-to-server",
    "frequency": "Streaming"
  },
  "identityNamespaces": {
    "external_id": {
      "acceptsAttributes": true,
      "acceptsCustomNamespaces": true
    },
    "another_id": {
      "acceptsAttributes": true,
      "acceptsCustomNamespaces": true
    }
  },
  "destinationDelivery": [
    {
      "authenticationRule": "CUSTOMER_AUTHENTICATION",
      "destinationServerId": "9c77000a-4559-40ae-9119-a04324a3ecd4"
    }
  ],
  "inputSchemaId": "cc8621770a9243b98aba4df79898b1ed"
}

Step 3: Create transformation template - Use templating language to specify the message output format

Based on the payloads that your destination supports, you must create a template that transforms the format of the exported data from Adobe XDM format into a format supported by your destination. See template examples in the section Using a templating language for the identity, attributes, and segment membership transformations and use the template authoring tool provided by Adobe.

Step 4: Create audience metadata configuration

For some destinations, Destination SDK requires that you configure an audience metadata template to programmatically create, update, or delete audiences in your destination. Refer to Audience metadata management for information on when you need to set up this configuration and how to do it.

Step 5: Create credentials configuration / Set up authentication

Depending on whether you specify "authenticationRule": "CUSTOMER_AUTHENTICATION" or "authenticationRule": "PLATFORM_AUTHENTICATION" in the destination configuration above, you can set up authentication for your destination by using the /destination or the /credentials endpoint.

  • Most common case: If you selected "authenticationRule": "CUSTOMER_AUTHENTICATION" and your destination supports the OAuth 2 authentication method, read OAuth 2 authentication.
  • If you selected "authenticationRule": "PLATFORM_AUTHENTICATION", refer to Credentials configuration in the reference documentation.

Step 6: Test your destination

After setting up your destination using the templates in the previous steps, you can use the destination testing tool to test the integration between Adobe Experience Platform and your destination.

Next steps

Adobe will set your destination live behind a feature flag in Experience Platform. You can now test workflows to export data from Experience Platform to your destination. After confirming that everything works as intended, use our self-service documentation process to create a documentation page for your destination.

On this page