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. You can explore and navigate files from within your source using the base connection ID. Additionally, you can identify the specific items you wish to ingest, including details on the data types and formats of those items.

To create a base connection ID, make a POST request to the /connections endpoint while providing your Stripe authentication credentials as part of the request body.

API format

POST /connections

Request

The following request creates a base connection for Stripe:

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": "Stripe base connection",
      "description": "Authenticated base connection for Stripe",
      "connectionSpec": {
          "id": "cc2c31d6-7b8c-4581-b49f-5c8698aa3ab3",
          "version": "1.0"
      },
      "auth": {
          "specName": "OAuth2 Refresh Code",
          "params": {
            "accessToken": "{ACCESS_TOKEN}",
          }
      }
  }'
Property
Description
name
The 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.
description
An optional value that you can include to provide more information on your base connection.
connectionSpec.id
The source’s connection spec ID. The connection spec ID for Stripe is cc2c31d6-7b8c-4581-b49f-5c8698aa3ab3, and this ID is fixed.
auth.specName
The authentication type that you are using to authenticate your source to Experience Platform.
auth.params.accessToken
The access token of your Stripe account. Read the Stripe authentication guide for steps on how to retrieve your access token.

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": "a9950001-a386-4642-a0cd-5eaac6db5556",
  "etag": "\"dc01244d-0000-0200-0000-65ea4e500000\""
}