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

API format

POST /connections

Request

The following request creates a base connection for Oracle Object Storage:

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": "Oracle Object Storage connection",
        "description": "Oracle Object Storage connection",
        "auth": {
            "specName": "Access Key",
            "params": {
                "serviceUrl": "{SERVICE_URL}",
                "accessKey": "{ACCESS_KEY}",
                "secretKey": "{SECRET_KEY}",
                "bucketName": "{BUCKET_NAME}",
                "folderPath", "{FOLDER_PATH}"
            }
        },
        "connectionSpec": {
            "id": "c85f9425-fb21-426c-ad0b-405e9bd8a46c",
            "version": "1.0"
        }
    }'
PropertyDescription
auth.params.serviceUrlThe Oracle Object Storage endpoint required for authentication.
auth.params.accessKeyThe Oracle Object Storage access key ID required for authentication.
auth.params.secretKeyThe Oracle Object Storage password required for authentication.
auth.params.bucketNameThe allowed bucket name required if the user has restricted access.
auth.params.folderPathThe allowed folder path required if the user has restricted access.
connectionSpec.idThe Oracle Object Storage connection spec ID: c85f9425-fb21-426c-ad0b-405e9bd8a46c.

Response

A successful response returns the connection ID of the newly created connection. This ID is required to explore your cloud storage data in the next tutorial.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Next steps

By following this tutorial, you have created an Oracle Object Storage connection using the Flow Service API, and have obtained its unique connection ID. You can use this connection ID to explore cloud storages using the Flow Service API.