A base connection represents the authenticated connection between a source and Adobe Experience Platform.
Read this document to learn how to create a base connection for PathFactory using the Flow Service API.
This guide requires a working understanding of the following components of Experience Platform:
For information on how to successfully make calls to Platform APIs, see the guide on getting started with Platform APIs.
The following section provides additional information that you will need to know in order to successfully connect to PathFactory using the Flow Service API.
To access your PathFactory account on the Platform, you must provide the following values:
Credential | Description |
---|---|
Username | Your PathFactory account username. This is essential for identifying your account in the system. |
Password | The password associated with your PathFactory account. Ensure this is kept secure to prevent unauthorized access. |
Domain | The domain associated with your PathFactory account. This typically refers to the unique identifier within your PathFactory URL. |
Access Token | A unique token used for API authentication to ensure secure communication between your systems and PathFactory. |
API Endpoints | Specific API endpoints for accessing data: Visitors, Sessions, and Page Views. Each endpoint corresponds to different data sets you can retrieve. Note: These are pre-defined by PathFactory and are specific to the data you intend to access:
|
For more information on how to secure and use your credentials, and how to obtain and refresh your access token, visit the PathFactory Support Center. This resource offers comprehensive guides on managing your credentials and ensuring effective and secure API integration.
A base connection retains information between your source and 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 PathFactory authentication credentials as part of the request body.
API format
POST /connections
Request
The following request creates a base connection for PathFactory:
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": "PathFactory base connection",
"description": "PathFactory base connection",
"auth": {
"specName": "Basic Authentication",
"params": {
"host": "acme-ab12c3d4e5fg6hijk7lmnop8qrst"
"clientId": "pathfactory",
"clientSecret": "xxxx"
}
},
"connectionSpec": {
"id": "ea1c2a08-b722-11eb-8529-0242ac130003",
"version": "1.0"
}
}'
Property | Description |
---|---|
auth.params.clientId |
The client ID associated with your PathFactory application. |
auth.params.clientSecret |
The client secret associated with your PathFactory application. |
connectionSpec.id |
The PathFactory connection specification ID: ea1c2a08-b722-11eb-8529-0242ac130003 . |
Response
A successful response returns the newly created connection, including its unique connection identifier (id
). This ID is required to explore your data in the next tutorial.
{
"id": "2fce94c1-9a93-4971-8e94-c19a93097129",
"etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}
By following this tutorial, you have created a PathFactory base connection using the Flow Service API. You can use this base connection ID in the following tutorials: