[Beta 版]{class="badge informative"}
使用流服务API为Oracle NetSuite Entities创建源连接和数据流
NOTE
Oracle NetSuite Entities源为测试版。 有关使用测试版标记源的更多信息，请参阅源概述。
阅读以下教程，了解如何使用Flow Service API将联系人和客户数据从您的Oracle NetSuite Activities Entities帐户引入Adobe Experience Platform。
快速入门
本指南要求您对Experience Platform的以下组件有一定的了解：
以下部分提供使用Flow Service API成功连接到Oracle NetSuite Entities所需了解的其他信息。
身份验证
有关如何检索身份验证凭据的信息，请阅读Oracle NetSuite 概述。
使用平台API
有关如何成功调用平台API的信息，请参阅平台API快速入门指南。
使用Flow Service API将Oracle NetSuite Entities连接到平台
下面概述了验证Oracle NetSuite Entities源、创建源连接以及创建数据流以将客户和联系人数据引入到Experience Platform时需要执行的步骤。
创建基本连接 base-connection
基本连接会保留您的源和平台之间的信息，包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件，并标识要摄取的特定项目，包括有关其数据类型和格式的信息。
要创建基本连接ID，请在将Oracle NetSuite Entities身份验证凭据作为请求正文的一部分提供时，向/connections端点发出POST请求。
API格式
POST /connections
请求
以下请求为Oracle NetSuite Entities创建基本连接：
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 NetSuite Entities base connection",
"description": "Authenticated base connection for Oracle NetSuite Entities",
"connectionSpec": {
"id": "fdf850b4-5a8d-4a5a-9ce8-4caef9abb2a8",
"version": "1.0"
},
"auth": {
"specName": "OAuth2 Client Credential",
"params": {
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}"
"accessTokenUrl": "{ACCESS_TOKEN_URL}",
"accessToken": "{ACCESS_TOKEN_URL}"
}
}
}'
属性
描述
name基础连接的名称。 确保基本连接的名称是描述性的，因为您可以使用此名称查找有关基本连接的信息。
description可包含的可选值，用于提供有关基本连接的更多信息。
connectionSpec.id源的连接规范ID。 在您的源通过Flow Service API注册和批准后，可以检索此ID。
auth.specName用于向Platform验证源的身份验证类型。
auth.params.clientId创建集成记录时的客户端ID值。 可在此处找到创建交互记录的进程。 该值是一个与
7fce.....b42f类似的64个字符的字符串。auth.params.clientSecret创建集成记录时的客户端ID值。 可在此处找到创建交互记录的进程。 该值是一个与
5c98.....1b46类似的64个字符的字符串。auth.params.accessTokenUrlNetSuite访问令牌URL，类似于
https://{ACCOUNT_ID}.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token，您将在其中将ACCOUNT_ID替换为您的NetSuite帐户ID。auth.params.accessToken访问令牌值在OAuth 2.0授权代码授予流程教程的步骤二的末尾生成。 访问令牌的过期有效期仅为60分钟。 该值是一个格式为JSON Web令牌(JWT)的1024字符字符串，类似于
eyJr......f4V0。响应
成功的响应返回新创建的基本连接，包括其唯一连接标识符(id)。 在下一步中浏览源的文件结构和内容时，需要此ID。
{
"id": "60c81023-99b4-4aae-9c31-472397576dd2",
"etag": "\"fa003785-0000-0200-0000-6555c5310000\""
}
浏览您的源 explore
获得基本连接ID后，您现在可以通过向/connections端点执行GET请求来探索源数据的内容和结构，同时将基本连接ID作为查询参数提供。
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}
请求
执行GET请求以浏览源的文件结构和内容时，必须包括下表列出的查询参数：
参数
描述
{BASE_CONNECTION_ID}上一步中生成的基本连接ID。
objectType=rest您希望探索的对象类型。 目前，此值始终设置为
rest。{OBJECT}只有在查看特定目录时才需要此参数。 其值表示您希望浏览的目录的路径。 对于此源，该值将为
json。fileType=json您要带到Platform的文件类型。 当前，
json是唯一支持的文件类型。{PREVIEW}一个布尔值，定义连接的内容是否支持预览。
{SOURCE_PARAMS}为要带到Platform的源文件定义参数。 要检索{SOURCE_PARAMS}的已接受格式类型，必须在base64中编码整个字符串。
Oracle NetSuite Entities支持客户和联系人数据检索。 根据您要使用的对象类型，传递以下任一项：
customer：检索特定客户数据，包括客户名称、地址和密钥标识符等详细信息。contact：检索联系人姓名、电子邮件、电话号码以及与客户关联的任何自定义联系人相关字段。
客户
对于Oracle NetSuite Entities，要检索联系人数据，{SOURCE_PARAMS}的值将作为{"object_type":"customer"}传递。 在base64中进行编码时，它等于eyAib2JqZWN0X3R5cGUiOiAiY3VzdG9tZXIifQ%3D%3D，如下所示。
| code language-shell |
|---|
|
联系人
对于Oracle NetSuite Entities，要检索联系人数据，{SOURCE_PARAMS}的值将作为{"object_type":"contact"}传递。 在base64中进行编码时，它等于eyAib2JqZWN0X3R5cGUiOiAiY29udGFjdCJ9，如下所示。
| code language-shell |
|---|
|
响应
同样，根据您利用收到的响应的对象类型，如下所示：
NOTE
一些记录已被截断，以便更好地呈现。
客户
成功的响应会返回如下结构。
| accordion | ||
|---|---|---|
| 选择以查看JSON有效负载 | ||
|
联系人
成功的响应会返回如下结构。
| accordion | ||
|---|---|---|
| 选择以查看JSON有效负载 | ||
|
创建源连接 source-connection
您可以通过向Flow Service API的/sourceConnections端点发出POST请求来创建源连接。 源连接由连接ID、源数据文件的路径以及连接规范ID组成。
API格式
POST /sourceConnections
请求
以下请求为Oracle NetSuite Entities创建源连接：
客户
检索客户数据时，object_type属性值应为customer。
| code language-shell |
|---|
|
联系人
检索联系数据时，object_type属性值应为contact。
| code language-shell |
|---|
|
属性
描述
name源连接的名称。 请确保源连接的名称是描述性的，因为您可以使用此名称查找有关源连接的信息。
description可包含的可选值，用于提供有关源连接的更多信息。
baseConnectionIdOracle NetSuite Entities的基本连接ID。 此ID是在前面的步骤中生成的。
connectionSpec.id与源对应的连接规范ID。
data.format要摄取的Oracle NetSuite Entities数据的格式。 当前，唯一支持的数据格式为
json。object_typeOracle NetSuite Entities支持客户和联系人检索。 根据所需的实体，传递以下任一项：
customer：检索特定客户数据，包括客户名称、地址和密钥标识符等详细信息。contact：检索联系人姓名、电子邮件、电话号码以及与客户关联的任何自定义联系人相关字段。
响应
成功的响应返回新创建的源连接的唯一标识符(id)。 此ID是稍后步骤创建数据流所必需的。
{
"id": "574c049f-29fc-411f-be0d-f80002025f51",
"etag": "\"0704acb3-0000-0200-0000-6555c5470000\""
}
创建目标XDM架构 target-schema
为了在Platform中使用源数据，必须创建目标架构，以根据您的需求构建源数据。 然后，使用目标架构创建包含源数据的Platform数据集。
通过向架构注册表API执行POST请求，可以创建目标XDM架构。
有关如何创建目标XDM架构的详细步骤，请参阅有关使用API 创建架构的教程。
创建目标数据集 target-dataset
可以通过向目录服务API执行POST请求，在有效负载中提供目标架构的ID来创建目标数据集。
有关如何创建目标数据集的详细步骤，请参阅有关使用API创建数据集的教程。
创建目标连接 target-connection
目标连接表示与要存储所摄取数据的目标的连接。 要创建目标连接，您必须提供对应于数据湖的固定连接规范ID。 此ID为： c604ff05-7f1a-43c0-8e18-33bf874cb11c。
现在，您拥有目标架构、目标数据集以及到数据湖的连接规范ID。 使用这些标识符，您可以使用Flow Service API创建目标连接，以指定将包含入站源数据的数据集。
API格式
POST /targetConnections
请求
以下请求为Oracle NetSuite Entities创建目标连接：
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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 NetSuite Entities Target Connection Generic Rest",
"description": " Oracle NetSuite Entities Connection Generic Rest",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "parquet_xdm",
"schema": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/325fd5394ba421246b05c0a3c2cd5efeec2131058a63d473",
"version": "1.2"
}
},
"params": {
"dataSetId": "65004470082ac828d2c3d6a0"
}
}'
属性
描述
name目标连接的名称。 确保目标连接的名称是描述性的，因为您可以使用此名称查找有关目标连接的信息。
description可包含的可选值，用于提供有关目标连接的更多信息。
connectionSpec.id对应于数据湖的连接规范ID。 此固定ID为：
6b137bf6-d2a0-48c8-914b-d50f4942eb85。data.format要摄取的Oracle NetSuite Entities数据的格式。
params.dataSetId在上一步中检索到的目标数据集ID。
响应
成功的响应返回新目标连接的唯一标识符(id)。 此ID在后续步骤中是必需的。
{
"id": "382fc614-3c5b-46b9-a971-786fb0ae6c5d",
"etag": "\"e0016100-0000-0200-0000-655707a40000\""
}
创建映射 mapping
要将源数据摄取到目标数据集中，必须首先将其映射到目标数据集所遵循的目标架构。 这是通过向Data Prep API执行POST请求来实现的，该请求具有在请求有效负载中定义的数据映射。
API格式
POST /conversion/mappingSets
请求
以下请求为DNL NetSuite Entities创建映射
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-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 '{
"outputSchema": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/b156e6f818f923e048199173c45e55e20fd2487f5eb03d22",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"sourceType": "ATTRIBUTE",
"source": "items.id",
"destination": "_extconndev.NS_ID"
},
{
"sourceType": "ATTRIBUTE",
"source": "items.entitytitle",
"destination": "_extconndev.NS_entity_title"
},
{
"sourceType": "ATTRIBUTE",
"source": "items.datecreated",
"destination": "_extconndev.NS_datecreated"
},
{
"sourceType": "ATTRIBUTE",
"destination": "_extconndev.NS_email",
"source": "items.email"
},
{
"sourceType": "ATTRIBUTE",
"source": "items.lastmodifieddate",
"destination": "_extconndev.NS_lastmodified"
}
]
}'
属性
描述
outputSchema.schemaRef.id在之前的步骤中生成的目标XDM架构的ID。
mappings.sourceType正在映射的源属性类型。
mappings.source需要映射到目标XDM路径的源属性。
mappings.destination源属性将映射到的目标XDM路径。
响应
成功的响应返回新创建的映射的详细信息，包括其唯一标识符(id)。 在后续步骤中需要使用此值来创建数据流。
{
"id": "ddf0592bcc9d4ac391803f15f2429f87",
"version": 0,
"createdDate": 1597784069368,
"modifiedDate": 1597784069368,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
创建流 flow
将数据从Oracle NetSuite Entities引入到Platform的最后一步是创建数据流。 现在，您已准备以下必需值：
数据流负责从源中计划和收集数据。 您可以通过在有效负载中提供上述值时执行POST请求来创建数据流。
API格式
POST /flows
请求
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-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 NetSuite Entities connector Flow Generic Rest",
"description": "Oracle NetSuite Entities connector Description Flow Generic Rest",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"d8827440-339f-428d-bf38-5e2ab1f0f7bb"
],
"targetConnectionIds": [
"e349a15e-c639-4047-8b2a-154aa7a857d7"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "10787532e0994eb686e76bdab69a9e88",
"mappingVersion": 0
}
}
],
"scheduleParams": {
"startTime": 1700202649,
"frequency": "once"
}
}'
属性
描述
name您的数据流的名称。 确保数据流的名称是描述性的，因为您可以使用此名称查找数据流上的信息。
description可包含的可选值，用于提供有关数据流的更多信息。
flowSpec.id创建数据流所需的流规范ID。 此固定ID为：
6499120c-0b15-42dc-936e-847ea3c24d72。flowSpec.version流规范ID的相应版本。 此值默认为
1.0。sourceConnectionIds在之前的步骤中生成的源连接ID。
targetConnectionIds在之前的步骤中生成的目标连接ID。
transformations此属性包含需要应用于数据的各种转换。 将不符合XDM的数据引入到Platform时需要此属性。
transformations.name分配给转换的名称。
transformations.params.mappingId在之前的步骤中生成的映射ID。
transformations.params.mappingVersion映射ID的相应版本。 此值默认为
0。scheduleParams.startTime此属性包含有关数据流的摄取计划的信息。
scheduleParams.frequency数据流收集数据的频率。
scheduleParams.interval间隔指定两次连续流运行之间的周期。 间隔的值应为非零整数。
响应
成功的响应返回新创建的数据流的ID (id)。 您可以使用此ID监视、更新或删除数据流。
{
"id": "84c64142-1741-4b0b-95a9-65644eba0cf6",
"etag": "\"3901770b-0000-0200-0000-655708970000\""
}
附录
以下部分提供了有关监视、更新和删除数据流的步骤的信息。
监测数据流
创建数据流后，您可以监视通过它摄取的数据，以查看有关流运行、完成状态和错误的信息。 有关完整的API示例，请阅读有关使用API监视源数据流的指南。
更新您的数据流
通过提供数据流的ID，向Flow Service API的/flows端点发出PATCH请求，更新数据流的详细信息，例如其名称和描述，以及其运行计划和关联的映射集。 发出PATCH请求时，必须在If-Match标头中提供数据流唯一的etag。 有关完整的API示例，请阅读有关使用API更新源数据流的指南。
更新您的帐户
在提供您的基本连接ID作为查询参数的同时，通过执行对Flow Service API的PATCH请求来更新源帐户的名称、描述和凭据。 发出PATCH请求时，必须在If-Match标头中提供源帐户的唯一etag。 有关完整的API示例，请阅读有关使用API更新源帐户的指南。
删除您的数据流
在查询参数中提供要删除的数据流的ID时，通过向Flow Service API执行DELETE请求来删除数据流。 有关完整的API示例，请阅读有关使用API删除数据流的指南。
删除您的帐户
在提供要删除的帐户的基本连接ID时，通过向Flow Service API执行DELETE请求来删除您的帐户。 有关完整的API示例，请阅读有关使用API🔗删除源帐户的指南。
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089