使用创建常规REST API基本连接 Flow Service API
基本连接表示源和Adobe Experience Platform之间的已验证连接。
本教程将指导您完成创建基本连接的步骤。 Generic REST API 使用 Flow Service API.
快速入门
本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:
有关如何成功调用Platform API的信息,请参阅 Platform API快速入门.
收集所需的凭据
为了 Flow Service 以连接 Generic REST API,您必须提供所选身份验证类型的有效凭据。 Generic REST API 支持OAuth 2刷新代码和基本身份验证。 有关两种受支持的身份验证类型的凭据的信息,请参见下表。
OAuth 2刷新代码
host
requestParameterOverride
.authorizationTestUrl
clientId
clientSecret
accessToken
requestParameterOverride
.refreshToken
expirationDate
accessTokenUrl
requestParameterOverride
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.基本身份验证
host
username
password
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.创建基本连接
基本连接会保留您的源和平台之间的信息,包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
Generic REST API 支持基本身份验证和OAuth 2刷新代码。 有关如何使用任一身份验证类型进行身份验证的指导,请参阅以下示例。
创建 Generic REST API 使用OAuth 2刷新代码的基础连接
POST要使用OAuth 2刷新代码创建基本连接ID,请向 /connections
端点,同时提供OAuth 2凭据。
API格式
POST /connections
请求
以下请求为创建基本连接 Generic REST API:
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": "Generic REST API base connection with OAuth 2 refresh code",
"description": "Generic REST API base connection with OAuth 2 refresh code",
"connectionSpec": {
"id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
"version": "1.0"
},
"auth": {
"specName": "oAuth2RefreshCode",
"params": {
"host": "{HOST}",
"accessToken": "{ACCESS_TOKEN}"
}
}
}'
name
description
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.auth.specName
auth.params.host
auth.params.accessToken
响应
成功的响应会返回新创建的连接,包括其唯一连接标识符(id
)。 在下个教程中,需要此ID才能浏览您的数据。
{
"id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
"etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}
创建 Generic REST API 使用基本身份验证的基本连接
创建 Generic REST API POST基本连接使用基本身份验证,向 /connections
端点 Flow Service API,同时提供基本的身份验证凭据。
API格式
POST /connections
请求
以下请求为创建基本连接 Generic REST API:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"name": "Generic REST API base connection with basic authentication",
"description": "Generic REST API base connection with basic authentication",
"connectionSpec": {
"id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
"version": "1.0"
},
"auth": {
"specName": "Basic Authentication",
"params": {
"host": "{HOST}",
"username": "{USERNAME}",
"password": "{PASSWORD}"
}
}
}'
name
description
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
.auth.specName
auth.params.host
auth.params.username
auth.params.password
响应
成功的响应会返回新创建的基本连接,包括其唯一连接标识符(id
)。 在下一步中浏览源的文件结构和内容时,需要此ID。
{
"id": "9601747c-6874-4c02-bb00-5732a8c43086",
"etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}
后续步骤
在本教程之后,您已创建一个 Generic REST API 基本连接使用 Flow Service API。 您可以在下列教程中使用此基本连接ID: