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 Mixpanel authentication credentials as part of the request body.

API format

POST /connections

Request

The following request creates a base connection for Mixpanel:

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": "Mixpanel base connection",
      "description": "Mixpanel base connection to authenticate to Experience Platform",
      "connectionSpec": {
          "id": "fd2c8ff3-1de0-4f6b-8fa8-4264784870eb",
          "version": "1.0"
      },
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "username": "{USERNAME}",
              "password": "{PASSWORD}"
          }
      }
  }'
PropertyDescription
nameThe name of your base connection. Ensure that the name of your base connection is descriptive as you can use this to look up information on your base connection.
descriptionAn optional value that you can include to provide more information on your base connection.
connectionSpec.idThe connection specification ID of your source. This ID can be retrieved after your source is registered and approved through the Flow Service API.
auth.specNameThe authentication type that you are using to authenticate your source to Experience Platform.
auth.params.Contains the credentials required to authenticate your source.
auth.params.usernameThe username that corresponds with your Mixpanel account.
auth.params.passwordThe password that corresponds with your Mixpanel account.

Response

A successful response returns the newly created base connection, including its unique connection identifier (id). This ID is required to explore your source’s file structure and contents in the next step.

{
     "id": "70383d02-2777-4be7-a309-9dd6eea1b46d",
     "etag": "\"d64c8298-add4-4667-9a49-28195b2e2a84\""
}