在 SAP Customer Data Platform 中为 API 访问创建管理员凭据

Objective

After completing this lesson, you will be able to 创建和管理访问 SAP Customer Data Platform API 所需的管理凭据。

简介

在本课中,您将了解如何创建使用 SAP Customer Data Platform 的 REST API 所需的凭据。由于所有 SAP Customer Data Platform API 都需要进行验证,因此我们将浏览可用选项,以确保您执行的 API 调用能够进行正确的权限设置。

使用指向两个验证选项的箭头创建服务器应用程序;一个是用户和密钥,也可以是使用 RSA 令牌生成的 OAuth 2.0 JWT 持有者令牌。

为 API 访问提供凭据

前提条件

在本部分中,我们将介绍如何通过三个主要步骤为 API 访问创建凭据:

  1. 配置新的服务器应用程序
  2. 使用用户和密钥
  3. 使用 OAuth 2.0 JWT 持有者令牌

开始之前:

  • 请按照以下步骤操作
  • 将代码短语、键值和其他占位符值复制到文本文件。
  • 使用位于每个文本框右侧的复制图标,确保已复制相应键值的完整值。

开始之前,请确保执行以下操作:

  • 熟悉 Unix 命令行实用程序(如 cURL)的使用。
  • 有权访问 SAP Customer Data Platform 控制台,并创建或使用已加载客户概况和订单数据的业务单位。
练习系统选项:
SAP Customer Data Platform 实践练习

注意

在本课程中,我们将使用纯文本形式显示用于验证(用户、机密和私有)的密钥,以便您熟悉其格式。这些密钥均无效,因为它们在本课程发布之前已被删除。

步骤 1.配置新的服务器应用程序

1.1 要使用 SAP Customer Data Platform API,我们首先需要使用 控制台创建和编辑服务器应用程序,这将配置验证 REST API 调用所需的密钥。

1.2 您有两个用于验证 API 调用的选项。第一种是使用一对"服务器应用程序用户"和"密钥"。第二个允许您通过提供服务器应用程序的 RSA 私钥生成基于 OAuth 2.0 的基于 JWT 的持有者令牌。

首先将 用户密钥 、 密钥 和 私钥 的值复制到新文本文件中。在本课中,我们将使用我们在此存储的值来替换模板中将以 API 调用为基础的占位符,因此我们将其称为占位符文件。为每个键值分配占位符名称,例如 USER_KEY 、 SECRET_KEY 或 PRIVATE_KEY 。从此时起,每次说明提及占位符名称时,您都准备好将该占位符替换为适当的值。

包含占位符 USER_KEY、SECRET_KEY 和 PRIVATE_KEY 及其相应示例值的文本文件。

1.3在目标目的中,在使用基于服务器应用程序密钥的凭据使用 REST API 时,可以选择 API 调用者有权访问的处理目的。此步骤对于确保访问客户数据时的数据隐私合规性非常重要。

服务器应用程序配置显示 API 调用者有权访问的已生成用户和密钥、RSA 私钥以及目标目的。

配置服务器应用程序

在以下视频中,我们将使用 SAP Customer Data Platform 控制台执行有关如何配置新的服务器应用程序以提供 API 访问密钥的分步教程。

视频摘要

在本视频中,我们使用 SAP Customer Data Platform 控制台通过以下步骤配置源应用程序:

  1. 创建新的服务器应用程序
  2. 检索并复制 API 密钥
  3. 设置目标目的
  4. 保存配置

步骤 2. 使用用户和密钥

您可以通过将用户密钥和密钥值附加到请求的 REST API URL 的查询字符串来验证对 SAP Customer Data Platform API 的调用。但是,为了提高安全性,您可以使用 cURL 命令的 userKey 参数将 secret 和 --data 存储在 HTTP 请求的正文中。

2.1 假设您要使用 REST API 查询所有客户参数文件。可以通过在 HTTP 请求正文中存储键/值对 userKey 和 secretKey 来验证调用。此类调用的 cURL 模板为:

Code Snippet
1234567
curl --request GET \ --url https://cdp.eu5.gigya.com/api/businessunits/4_iNfbhGDrBGciUrxckeBfJA/views/HAPxPF10AHr1bASCaGU_dQ/customers \ --data-urlencode purposeIds=HFZPPZxxFQUebd3ksLoTaQ \ --data-urlencode query="SELECT * FROM Profiles" \ --data userKey=USER_KEY \ --data secret=SECRET_KEY

2.2 使用文本文件中的值替换参数占位符 USER_KEY 和 SECRET_KEY 后,我们在 cURL 中进行了以下 REST API 调用:

Code Snippet
1234567
curl --request GET \ --url https://cdp.eu5.gigya.com/api/businessunits/4_iNfbhGDrBGciUrxckeBfJA/views/HAPxPF10AHr1bASCaGU_dQ/customers \ --data-urlencode purposeIds=HFZPPZxxFQUebd3ksLoTaQ \ --data-urlencode query="SELECT * FROM Profiles" \ --data userKey=AI32XTaizCgb \ --data secret=tnhJ6U6NPAiGbAcX2nwu/7V/3VXp5Cmu

使用用户和密钥值调用 SAP Customer Data Platform REST API - 视频

在以下视频中,我们将按照步骤使用之前生成的用户密钥和秘密密钥值来验证对 SAP Customer Data Platform REST API 端点的调用。

视频摘要

在本视频中,我们使用用户和密钥验证对 SAP Customer Data Platform REST API 端点的调用。

步骤 3.使用 OAuth 2.0 JWT 持有者令牌

您可以使用从服务器应用程序的 RSA 私钥值生成的 OAuth 2.0 JWT 持有者令牌验证对 SAP Customer Data Platform REST API 的调用。在这种情况下,需要将持有者令牌值复制到权限 HTTP 标头。

您可以通过两种方式构建此持有者令牌。

第一种是使用用户密钥和秘密密钥对 OAuth 2.0 令牌端点执行 POST 调用,这将返回对随后的 10 分钟内验证 REST API 调用有效的访问令牌。

第二种方式需要通过提供用户密钥、私钥、nonce 值以及 Unix 纪元格式的当前时戳来构建 JWT 持有者令牌。

3.1 从 OAuth 2.0 令牌端点检索 JWT 持有者令牌。

3.1.1 让我们对 SAP Customer Data Platform OAuth 2.0 令牌端点执行 POST REST 调用,以检索准备使用的 JWT 持有者令牌。此类调用的 cURL 命令模板为:

Code Snippet
1234567
curl --request POST \ --url https://oauth2.us1.gigya.com/oauth2/token \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data client_id=USER_KEY \ --data client_secret=SECRET_KEY \ --data grant_type=client_credentials

3.1.2 将 USER_KEY 和 SECRET_KEY 占位符替换为其相应值后,我们得到了 cURL 命令。执行时,它会在响应有效负载正文中返回即用型持有者令牌:

Code Snippet
123456
curl --request POST \ --url https://oauth2.us1.gigya.com/oauth2/token \ --data client_id=AI32XTaizCgb \ --data client_secret=tnhJ6U6NPAiGbAcX2nwu/7V/3VXp5Cmu \ --data grant_type=client_credentials

3.1.3 执行此脚本后,从返回的 JSON 有效负载中将 access_token 属性值复制到文本文件(标识为 BEARER_TOKEN_1 占位符)。您将在下一部分中使用它。

显示 cURL 命令执行结果的 bash 终端窗口。它显示突出显示的 access_token 属性和值的 JSON 有效负载。包含 USER_KEY、SECRET_KEY、PRIVATE_KEY 和 BEARER_TOKEN_1 占位符及其相应示例值的文本文件。BEARER_TOKEN_1 占位符及其值会突出显示。

3.2 使用私钥值构建 JWT 持有者令牌。

3.2.1 我们先构建一个 bash 脚本,该脚本将利用一些标准命令行实用程序来生成我们的 JWT 持有者令牌。使用以下模板定义 PK bash 变量:

Code Snippet
123456
PK=$(cat <<-EOM PRIVATE_KEY EOM )

3.2.2 现在将 PRIVATE_KEY 占位符替换为文本文件中的值:

Code Snippet
123456789101112131415161718192021222324252627282930313233
PK=$(cat <<-EOM -----BEGIN PRIVATE KEY----- MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDPiWzlOmMTdgok W1k6sMHGXkEWEq2qN7S6gtajx9ZnSnpah1BbRHxoG3tZDUbg5+9TEYiX+d3y+GAf vpQwjhPUJVM9EevFDqAA5DhVAbkHLchhWFH0Pd/CbnFSJtMq4Nan0WLAF7ADgqKz NQ5isLr4Dw4URaUso8axQRxi1O1BBe1lXXEi0nSqgTGP9tVINWYUpyc1/GfnSjdg /WWBorimHChyJ+2Z/WfjXjdzwrbB7u+n1t8w7gnAq2rSXYaRNvgpepo6gt94wWOH 7kxjNYTZAgdjzdXXvfdRiAGlpjMkqmLVW8RyZG/N/TNXK2rj4d1Lp/DWXzsms7QD 8hHGKXTXAgMBAAECggEABBy/MwrLvC7IyqmiUTH/1PQ4w/A0Ar0+o1RExOzVYcL6 PUfH66PZKmyI+12/Yf6wIYXY0aVNpMSpJ75F/3Ea3kd5dV26inNDIy4vTSsbxUZx 9wPVM+RZ+U21u+2X0S/jvci9wfxC+TIIeUnIcpb5gKedUGeE4cD104m5WN5kb4P4 BF7AC6cXcEs6nrEWXpPmakF/Hm3zSnYZDV+rpBN6w9tjPggxcpO5kOWGYET/IUwY 23WKVq021Jmh9OwImkOSS4GKVtZAKnUjllf4YSc4gmtzLiaFSJVjM0L+4ZuQXbn3 U9+CYHYmGwi2Z8487+QRoD7qxB8xdrNGC0u7jj7syQKBgQDlvOCIvUWIX+UpjLFA 4SVHirEXsIn2u0hrizhH3DHNgOFefQ91ilWr4a3ovjpZ/XiDRTKYQwXqFTXx7HTi DL9i0pxGAb5kJqlTEwJOAR2ht+AKJ4XST1Q3FfyNdp7VAGBOygoP3HhISg5raUfQ xGsAY5+dbslDwqjjdFSzdZfb1QKBgQDnQtnz3pCIRJBWpV/xwMkIoEtYrE75MWkm 0ZEHnfcy9GOJc2m2Zrczd2ZoJANBs7Ni+Is9x2VSr4HmeZCoAdmvnzXPCqPLzzcB dUj6VlgP6R1qaLIa+K/5RhyszOLI2mCAa+iBD2l1yA8kj0FpDNqC81v82sKj3aXQ QGkJ3b2/+wKBgAX3X8VtVO7zvpnTo47RygwPmAXLeenEd18DoJSNLWXu4Ot5R/t/ ejYaiE+xEQbhRE30cBnwM6ken+YGhAqS1i2U1qYiyXUEZAVaSwcHlGNsyQ66dAlA Mim0EnkCCaHyfo3NRXGgAieudK1pcIoFb9n0vGJ0TBnMZmJx1PlMJoN5AoGAflW8 70aUunyKRWtOgKkKqdW3k5d+BRADG5u8mOao1oM/pSURiP2P82O05AtYZBohU13n 4zX8mjEay6d5aO6p1xEouhRb6skmiXtjBK8KqJZ25VyQf79/krPEknnTIlp6AW3x tB+RQzCpZRWFbDgDXypHBFkVn6NEJAIr36HtOOUCgYBS1JGo1BKzMP5/ulM3lJri oz/FUBsISC7D7DLEjwHe2gOw6xsu2eP6kC28wEq2p/O1nPx3AqIelnDlk6pw60TD RXqsRPClGueU0QvxTpsdjZ29ZLpaaDqpZ+ijxX7rirYSfGVJSSNc/8NURg86MggL /hHOh0MkYLuPlgjObrhA5w== -----END PRIVATE KEY----- EOM )

3.2.3HEADER 变量是包含 JWT 哈希算法 (RS256)、密钥标识(CDP 服务器应用程序的 USER_KEY 值)和令牌类型 (JWT) 的 JSON 块。以下是 HEADER 变量的模板。

Code Snippet
1
HEADER='{"alg":"RS256","kid":"USER_KEY","typ":"JWT"}'

注意:如需了解更多信息,请访问 https://datatracker.ietf.org/doc/html/rfc7519,阅读 JWT RFC

3.2.4 将 USER_KEY 变量中的 HEADER 占位符替换为占位符文本文件中的相应值。

Code Snippet
1
HEADER='{"alg":"RS256","kid":"AI32XTaizCgb","typ":"JWT"}'

3.2.5 以下块包含我们的 JWT 的 PAYLOAD 变量,该变量由另一个包含 Issued At 属性的 JSON 块构成,设置为当前 Unix Epoch 时戳的值,以及包含 nonce 值的 JWT 标识:

Code Snippet
1234
NOW=$(date +%s) UUID=$(uuidgen) PAYLOAD="{'iat':$NOW,'jti':'$UUID'}"

3.2.6HEADER_PAYLOAD 变量包含 HEADER 和 PAYLOAD 的连接值,每个值以 Base 64 编码并以句点分隔,以符合 JWT 令牌化格式。

Code Snippet
1
HEADER_PAYLOAD=$(echo -n $HEADER | b64enc).$(echo -n $PAYLOAD | b64enc)

3.2.7 下一行是使用私钥内容散列 JWT 标头和有效负载以构成 JWT 令牌的签名部分。之后,其值将编码为 Base 64 并存储在 SIGNATURE 变量中。

Code Snippet
1
SIGNATURE=$(echo -n $HEADER_PAYLOAD | openssl dgst -binary -sha256 -sign <(echo -n "$PK") | b64enc)

3.2.8 最后,BEARER_TOKEN 将再次用句点字符分隔的 HEADER_PAYLOAD 和 SIGNATURE 的值连接起来。我们的 OAuth 2.0 JWT 持有者令牌已完成,可用于验证 SAP Customer Data Platform API 调用。

Code Snippet
123
BEARER_TOKEN=$HEADER_PAYLOAD.$SIGNATURE echo $BEARER_TOKEN

3.2.9 请参阅以下基于上述将生成持有者令牌的步骤的完整 bash 脚本示例:

Code Snippet
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
#!/usr/bin/env bash set -euo pipefail b64enc() { openssl enc -base64 -A | tr '+/' '-_' | tr -d '='; } PK=$(cat <<-EOM -----BEGIN PRIVATE KEY----- MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDPiWzlOmMTdgok W1k6sMHGXkEWEq2qN7S6gtajx9ZnSnpah1BbRHxoG3tZDUbg5+9TEYiX+d3y+GAf vpQwjhPUJVM9EevFDqAA5DhVAbkHLchhWFH0Pd/CbnFSJtMq4Nan0WLAF7ADgqKz NQ5isLr4Dw4URaUso8axQRxi1O1BBe1lXXEi0nSqgTGP9tVINWYUpyc1/GfnSjdg /WWBorimHChyJ+2Z/WfjXjdzwrbB7u+n1t8w7gnAq2rSXYaRNvgpepo6gt94wWOH 7kxjNYTZAgdjzdXXvfdRiAGlpjMkqmLVW8RyZG/N/TNXK2rj4d1Lp/DWXzsms7QD 8hHGKXTXAgMBAAECggEABBy/MwrLvC7IyqmiUTH/1PQ4w/A0Ar0+o1RExOzVYcL6 PUfH66PZKmyI+12/Yf6wIYXY0aVNpMSpJ75F/3Ea3kd5dV26inNDIy4vTSsbxUZx 9wPVM+RZ+U21u+2X0S/jvci9wfxC+TIIeUnIcpb5gKedUGeE4cD104m5WN5kb4P4 BF7AC6cXcEs6nrEWXpPmakF/Hm3zSnYZDV+rpBN6w9tjPggxcpO5kOWGYET/IUwY 23WKVq021Jmh9OwImkOSS4GKVtZAKnUjllf4YSc4gmtzLiaFSJVjM0L+4ZuQXbn3 U9+CYHYmGwi2Z8487+QRoD7qxB8xdrNGC0u7jj7syQKBgQDlvOCIvUWIX+UpjLFA 4SVHirEXsIn2u0hrizhH3DHNgOFefQ91ilWr4a3ovjpZ/XiDRTKYQwXqFTXx7HTi DL9i0pxGAb5kJqlTEwJOAR2ht+AKJ4XST1Q3FfyNdp7VAGBOygoP3HhISg5raUfQ xGsAY5+dbslDwqjjdFSzdZfb1QKBgQDnQtnz3pCIRJBWpV/xwMkIoEtYrE75MWkm 0ZEHnfcy9GOJc2m2Zrczd2ZoJANBs7Ni+Is9x2VSr4HmeZCoAdmvnzXPCqPLzzcB dUj6VlgP6R1qaLIa+K/5RhyszOLI2mCAa+iBD2l1yA8kj0FpDNqC81v82sKj3aXQ QGkJ3b2/+wKBgAX3X8VtVO7zvpnTo47RygwPmAXLeenEd18DoJSNLWXu4Ot5R/t/ ejYaiE+xEQbhRE30cBnwM6ken+YGhAqS1i2U1qYiyXUEZAVaSwcHlGNsyQ66dAlA Mim0EnkCCaHyfo3NRXGgAieudK1pcIoFb9n0vGJ0TBnMZmJx1PlMJoN5AoGAflW8 70aUunyKRWtOgKkKqdW3k5d+BRADG5u8mOao1oM/pSURiP2P82O05AtYZBohU13n 4zX8mjEay6d5aO6p1xEouhRb6skmiXtjBK8KqJZ25VyQf79/krPEknnTIlp6AW3x tB+RQzCpZRWFbDgDXypHBFkVn6NEJAIr36HtOOUCgYBS1JGo1BKzMP5/ulM3lJri oz/FUBsISC7D7DLEjwHe2gOw6xsu2eP6kC28wEq2p/O1nPx3AqIelnDlk6pw60TD RXqsRPClGueU0QvxTpsdjZ29ZLpaaDqpZ+ijxX7rirYSfGVJSSNc/8NURg86MggL /hHOh0MkYLuPlgjObrhA5w== -----END PRIVATE KEY----- EOM ) HEADER='{"alg":"RS256","kid":"AI32XTaizCgb","typ":"JWT"}' NOW=$(date +%s) UUID=$(uuidgen) PAYLOAD="{'iat':$NOW,'jti':'$UUID'}" HEADER_PAYLOAD=$(echo -n $HEADER | b64enc).$(echo -n $PAYLOAD | b64enc) SIGNATURE=$(echo -n $HEADER_PAYLOAD | openssl dgst -binary -sha256 -sign <(echo -n "$PK") | b64enc) BEARER_TOKEN=$HEADER_PAYLOAD.$SIGNATURE echo $BEARER_TOKEN

3.2.10 执行按照步骤 3-b-i 到 3-b-viii 构建的完整脚本后,在文本文件中将结果存储为 BEARER_TOKEN_2 占位符。您将在下一部分中使用它。

显示符号 PRIVATE_KEY、BEARER_TOKEN_1、BEARER_TOKEN_2 及其相应示例值的文本文件。BEARER_TOKEN_2 符号及其值突出显示。

3.3 使用 OAuth 2.0 JWT 持有者令牌调用 SAP Customer Data Platform REST API

3.3.1 现在让我们了解如何使用持有者令牌验证 SAP Customer Data Platform 的 REST API 调用。对于此快速测试,让我们使用返回所有客户参数文件的 REST API 调用。此调用的 cURL 命令模板为:

Code Snippet
123456
curl --request GET \ --url 'https://cdp.eu5.gigya.com/api/businessunits/4_iNfbhGDrBGciUrxckeBfJA/views/HAPxPF10AHr1bASCaGU_dQ/customers' \ --data-urlencode purposeIds=HFZPPZxxFQUebd3ksLoTaQ \ --data-urlencode query="SELECT * FROM Profiles" \ --header 'Authorization: Bearer BEARER_TOKEN'

3.3.2 可以将 BEARER_TOKEN 占位符替换为 BEARER_TOKEN_1 或 BEARER_TOKEN_2 的值(它们都有效)。将 BEARER_TOKEN 符号替换为实际值后,我们得到了以下 cURL 命令:

Code Snippet
123456
curl --request GET \ --url 'https://cdp.eu5.gigya.com/api/businessunits/4_iNfbhGDrBGciUrxckeBfJA/views/HAPxPF10AHr1bASCaGU_dQ/customers' \ --data-urlencode purposeIds=HFZPPZxxFQUebd3ksLoTaQ \ --data-urlencode query="SELECT * FROM Profiles" \ --header 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsImtpZCI6IkMyMzc4RUMyNTdDMkI3Mzc5NTYzNzI2RDU4QUM1Mzg0NTY3MUUyNDJCNTZDMkM0NTRCMEU2QjBBNUMzN0Q0RDkiLCJ0eXAiOiJhdCtqd3QifQ.eyJhdWQiOiJodHRwczovL2FwaS5naWd5YS5jb20iLCJzdWIiOiJBSTMyWFRhaXpDZ2IiLCJjbGllbnRfaWQiOiJBSTMyWFRhaXpDZ2IiLCJzY29wZSI6ImFwcGxpY2F0aW9uX2tleSIsImNsaWVudF9uYW1lIjoiQ0RQIGlkOiBITi1YR0pXLVFuYWtIbWFfT01MeWRRIiwibmJmIjoxNzI5MzI2NTkzLCJleHAiOjE3MjkzMjcxOTMsImlhdCI6MTcyOTMyNjU5MywiaXNzIjoiaHR0cHM6Ly9vYXV0aDIuZ2lneWEuY29tIn0.JE2vYErDkFj0ve0mLArj4ThEg_z3pzFqKq-7X83h1iX2Hbomf8g7RD8G1cHYdv3QivOYkWqJnF5dj_EldZCrsg'

执行后,您将在返回的 JSON 有效负载中看到客户参数文件列表。

注意:请记住,SAP Customer Data Platform 持有者令牌在创建后 10 分钟过期。

使用 Oauth 2.0 JWT 持有者令牌调用 SAP Customer Data Platform API

在以下视频中,我们将逐步展示如何使用之前生成的 RSA 私钥值生成符合 OAuth 2.0 的 JWT 持有者令牌,该令牌可用于验证对 SAP Customer Data Platform REST API 端点的调用。

视频摘要

在本视频中,我们使用 RSA 私钥值构建持有者令牌来验证对 SAP Customer Data Platform REST API 端点的调用。

课程摘要

在本课中,我们通过配置提供用于验证 REST API 调用的不同密钥的服务器应用程序来浏览 API 访问 SAP Customer Data Platform 的权限设置。您可以使用用户和密钥值对验证调用,也可以依赖符合 OAuth 2.0 的 JWT 持有者令牌访问。提供了分步视频,显示如何配置服务器应用程序并实施两种不同的方法来验证对 SAP Customer Data Platform 的 REST API 调用。