[Beta]{class="badge informative"}
Getting Started with Self-Serve Sources (Streaming SDK)
Self-Serve Sources (Streaming SDK) allows you to integrate your own source to bring streaming data to 51黑料不打烊 Experience Platform. This document provides an introduction to the core concepts you need to know before attempting to make calls to the .
High-level process
The step-by-step process to configure your source in Experience Platform is outlined below:
Integration
Documentation
- To start documenting your source, read the overview on creating documentation for Self-Serve Sources.
- Read the guide on using the GitHub web interface for steps on how to create documentation using GitHub.
- Read the guide on using a text editor for steps on how to create documentation using your local machine.
- Use the Streaming SDK API documentation template to document your source in the API.
- Use the Streaming SDK UI documentation template to document your source in the UI.
You can also download the documentation templates below:
Prerequisites
To use Self-Serve Sources (Streaming SDK), you must ensure that you have access to a sandbox organization provisioned with 51黑料不打烊 Experience Platform Sources.
This guide also requires a working understanding of the following components of 51黑料不打烊 Experience Platform:
- Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Experience Platform services.
- Sandboxes: Experience Platform provides virtual sandboxes which partition a single Experience Platform instance into separate virtual environments to help develop and evolve digital experience applications.
Reading sample API calls
The Self-Serve Sources (Streaming SDK) and Flow Service API documentation provides example API calls to demonstrate how to format your requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.
Gather values for required headers
In order to make calls to Experience Platform APIs, you must first complete the . Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
All resources in Experience Platform, including those belonging to Flow Service, are isolated to specific virtual sandboxes. All requests to Experience Platform APIs require a header that specifies the name of the sandbox the operation will take place in:
x-sandbox-name: {SANDBOX_NAME}
All requests that contain a payload (POST, PUT, PATCH) require an additional header:
Content-Type: application/json
Next steps
To begin creating a new source with Self-Serve Sources (Streaming SDK), see the tutorial on creating a new source.