Submit your source
The final step to integrating your new source to Adobe Experience Platform using Self-Serve Sources (Batch SDK) is to test your source for verification. Once successful, you can then submit your new source by contacting your Adobe representative.
The following document provides steps on how to test and debug your source using the Flow Service API.
Getting started
- For information on how to successfully make calls to Platform APIs, see the guide on getting started with Platform APIs.
- For information on how to generate your credentials for Platform APIs, see the tutorial on authenticating and accessing Experience Platform APIs.
- For information on how to set up Postman for Platform APIs, see the tutorial on setting up developer console and Postman.
- To help your testing and debugging process, download the Self-Serve Sources verification collection and environment here and follow the steps outlined below.
Test your source
To test your source, you must run the Self-Serve Sources verification collection and environment on Postman while providing the appropriate environment variables that pertain to your source.
To start testing, you must first set up the collection and environment on Postman. Next, specify the connection specification ID that you want to test.
Specify authSpecName
Once you have entered your connection specification ID, you must then specify the authSpecName
that you are using for your base connection. Depending on your choice, this could be either OAuth 2 Refresh Code
or Basic Authentication
. Once you specify your authSpecName
, you must then include its required credentials in your environment. For example, if you specify authSpecName
as OAuth 2 Refresh Code
, then you must provide the required credentials for OAuth 2, which are host
and accessToken
.
Specify sourceSpec
With your authentication specification parameters added, you must next add required properties from your source specification. You can find the required properties in sourceSpec.spec.properties
. In the case of the MailChimp Members example below, the only required property is listId
, which means listId
and it’s corresponding ID value to your Postman environment.
"spec": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Define user input parameters to fetch resource values.",
"properties": {
"listId": {
"type": "string",
"description": "listId for which members need to fetch."
}
}
}
Once your authentication and source specification parameters are provided, you can start populating the rest of your environment variables, see the table below for reference:
flowSpecificationId
and targetConnectionSpecId
, which are fixed values.x-api-key
x-api-key
.c8d9a2f5c1e03789bd22e8efdd1bdc1b
x-gw-ims-org-id
x-gw-ims-org-id
information.ABCEH0D9KX6A7WA7ATQE0TE@adobeOrg
authorizationToken
authorizationToken
.Bearer authorizationToken
schemaId
https://ns.adobe.com/{TENANT_ID}.schemas.0ef4ce0d390f0809fad490802f53d30b
schemaVersion
application/vnd.adobe.xed-full-notext+json; version=1
schemaAltId
meta:altId
that is returned alongside the schemaId
when creating a new schema._{TENANT_ID}.schemas.0ef4ce0d390f0809fad490802f53d30b
dataSetId
5f3c3cedb2805c194ff0b69a
mappings
[{"destinationXdmPath":"person.name.firstName","sourceAttribute":"email.email_id","identity":false,"version":0},{"destinationXdmPath":"person.name.lastName","sourceAttribute":"email.activity.action","identity":false,"version":0}]
mappingId
bf5286a9c1ad4266baca76ba3adc9366
connectionSpecId
2e8580db-6489-4726-96de-e33f5f60295f
flowSpecificationId
RestStorageToAEP
. This is a fixed value.6499120c-0b15-42dc-936e-847ea3c24d72
targetConnectionSpecId
c604ff05-7f1a-43c0-8e18-33bf874cb11c
verifyWatTimeInSecond
40
startTime
1597784298
Once you have provided all of your environment variables, you can start running the collection using the Postman interface. In the Postman interface, select the ellipses (…) beside Sources SSSs Verification Collection and then select Run collection.
The Runner interface appears, allowing you to configure the run order of your dataflow. Select Run SSS Verification Collection to run the collection.
Submit your source
Once your source is able to complete the entire workflow you can proceed to contact your Adobe representative and submit your source for integration.