Create a Shopify base connection using the Flow Service API

A base connection represents the authenticated connection between a source and Adobe Experience Platform.

Read this guide to learn how to create a base connection for the Shopify source connector using the Flow Service API.

Getting started

This guide requires a working understanding of the following components of Adobe Experience Platform:

Gather required credentials

You must have valid Shopify authentication credentials to create a base connection. For details on the required credentials and how to obtain them, refer to the Shopify source connector overview.

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

API format

POST /connections

Basic authentication

The following request creates a base connection for Shopify using basic authentication:

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": "Shopify source",
      "description": "Shopify source",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "host": "{HOST}",
              "accessToken": "{ACCESS_TOKEN}"
          }
      },
      "connectionSpec": {
          "id": "4f63aa36-bd48-4e33-bb83-49fbcd11c708",
          "version": "1.0"
      }
  }

{
    "id": "582f4f8d-71e9-4a5c-a164-9d2056318d6c",
    "etag": "\"d600d3ae-0000-0200-0000-5fa99a3d0000\""
}

Access token based

The following request creates a base connection for Shopify using basic authentication:

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": "Create shopify v2 Test Connection",
    "description": "Connection creation for Shopify",
    "auth": {
      "specName": "Access Token Based",
      "params": {
        "host": "{HOST}",
        "accessToken": "{ACCESS_TOKEN}"
      }
    },
    "connectionSpec": {
      "id": "4f63aa36-bd48-4e33-bb83-49fbcd11c708",
      "version": "1.0"
    }
}'

{
    "id": "92a00150-f3cc-4283-8fc4-6232725bcf33",
    "etag": "\"bb04d1f7-0000-0200-0000-69807e830000\""
}

Next steps

By following this tutorial, you have created a Shopify base connection using the Flow Service API. You can use this base connection ID in the following tutorials: