Using Experience Platform APIs
For information on how to successfully make calls to Experience Platform APIs, see the guide on getting started with Experience Platform APIs.
Create a base connection
A base connection retains information between your source and Experience Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.
To create a base connection ID, make a POST request to the /connections
endpoint while providing your Hive authentication credentials as part of the request parameters.
API format
POST /connections
Request
The following request creates a base connection for Hive:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Apache Hive test connection",
"description": "A test connection for Apache Hive",
"auth": {
"specName": "HDInsights Basic Authentication",
"params": {
"connectionString": "{CONNECTION_STRING}"
}
},
"connectionSpec": {
"id": "aac9bbd4-6c01-46ce-b47e-51c6f0f6db3f",
"version": "1.0"
}
}'
Parameter | Description |
---|---|
auth.params.connectionString | The connection string associated with your Hive account. |
connectionSpec.id | The Hive connection specification ID: aac9bbd4-6c01-46ce-b47e-51c6f0f6db3f . |
Response
A successful response returns details of the newly created connection, including its unique identifier (id
). This ID is required to explore your data in the next tutorial.
{
"id": "9f6e4311-e032-4c00-ae43-11e032bc00c7",
"etag": "\"f4004fb7-0000-0200-0000-5e865c1e0000\""
}