的 Generic REST 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刷新代码和基本身份验证。 有关两种受支持身份验证类型的凭据的信息,请参阅下表。
凭据 | 描述 |
---|---|
host |
您请求的源的主机URL。 此值是必需的,无法使用 requestParameterOverride . |
authorizationTestUrl |
(可选)创建基本连接时,授权测试URL用于验证凭据。 如果未提供,则在创建源连接步骤期间会自动检查凭据。 |
clientId |
(可选)与您的用户帐户关联的客户端ID。 |
clientSecret |
(可选)与您的用户帐户关联的客户端密钥。 |
accessToken |
用于访问应用程序的主身份验证凭据。 访问令牌表示应用程序访问用户数据特定方面的授权。 此值是必需的,无法使用 requestParameterOverride . |
refreshToken |
(可选)在访问令牌过期时用于生成新访问令牌的令牌。 |
expirationDate |
(可选)用于定义访问令牌到期日期的隐藏值。 |
accessTokenUrl |
(可选)用于获取访问令牌的URL端点。 |
requestParameterOverride |
(可选)用于指定要覆盖的凭据参数的属性。 |
connectionSpec.id |
连接规范返回源的连接器属性,包括与创建基连接和源连接相关的验证规范。 的连接规范ID Generic REST API 为: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 . |
凭据 | 描述 |
---|---|
host |
您请求的源的主机URL。 |
username |
与您的用户帐户对应的用户名。 |
password |
与您的用户帐户对应的密码。 |
connectionSpec.id |
连接规范返回源的连接器属性,包括与创建基连接和源连接相关的验证规范。 的连接规范ID Generic REST API 为: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 . |
基本连接保留了源和平台之间的信息,包括源的身份验证凭据、连接的当前状态和唯一基本连接ID。 基本连接ID允许您从源中浏览和导航文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
Generic REST API 支持基本身份验证和OAuth 2刷新代码。 有关如何使用这两种身份验证类型进行身份验证的指导,请参阅以下示例。
要使用OAuth 2刷新代码创建基本连接ID,请向 /connections
端点。
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 |
与关联的连接规范ID Generic REST API. 此固定ID是: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 . |
auth.specName |
用于向平台验证源的验证类型。 |
auth.params.host |
用于连接到的根URL Generic REST API 来源。 |
auth.params.accessToken |
用于验证源的相应访问令牌。 基于OAuth的身份验证需要此设置。 |
响应
成功的响应会返回新创建的连接,包括其唯一连接标识符(id
)。 在下一个教程中探索数据时需要此ID。
{
"id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
"etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}
创建 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 |
与关联的连接规范ID Generic REST API. 此固定ID是: 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 . |
auth.specName |
用于将源连接到平台的身份验证类型。 |
auth.params.host |
用于连接到的根URL Generic REST API 来源。 |
auth.params.username |
与您的 Generic REST API 来源。 基本身份验证需要此功能。 |
auth.params.password |
与您的 Generic REST API 来源。 基本身份验证需要此功能。 |
响应
成功的响应会返回新创建的基本连接,包括其唯一连接标识符(id
)。 在下一步中,需要此ID才能浏览源的文件结构和内容。
{
"id": "9601747c-6874-4c02-bb00-5732a8c43086",
"etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}
通过阅读本教程,您已创建 Generic REST API 基本连接使用 Flow Service API。 在以下教程中,您可以使用此基本连接ID: