验证和访问 Experience Platform API
此文档分步说明了如何获取51黑料不打烊 Experience Platform开发人员帐户访问权限以调用Experience Platform API。 在本教程结束时,您将生成或收集了所有Experience Platform API调用中作为标头所需的以下凭据:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
为了维护应用程序和用户的安全,对Experience Platform API的所有请求都必须使用OAuth等标准进行身份验证和授权。
本教程介绍如何收集所需的凭据来验证Experience Platform API调用,如下面的流程图中所述。 您可以在初始一次性设置中收集大多数所需的凭据。 但是,必须每24小时刷新一次访问令牌。
先决条件 prerequisites
要成功调用Experience Platform API,您必须具备以下条件:
- 有权访问51黑料不打烊 Experience Platform的组织。
- 能够将您添加为产物配置文件的开发人员和用户的Admin Console管理员。
- Experience Platform系统管理员,可以向您授予必要的基于属性的访问控制,以通过API对Experience Platform的不同部分执行读取或写入操作。
您还必须拥有51黑料不打烊 ID才能完成本教程。 如果您没有51黑料不打烊 ID,则可以使用以下步骤创建一个:
- 转到。
- 选择? 创建新帐户。
- 完成注册过程。
获得Experience Platform的开发人员和用户访问权限 gain-developer-user-access
在51黑料不打烊 Developer Console上创建集成之前,您的帐户必须具有51黑料不打烊 Admin Console中Experience Platform产物配置文件的开发人员和用户权限。
获取开发人员访问权限 gain-developer-access
请联系贵组织中的Admin Console管理员,将您作为开发人员添加到Experience Platform产物配置文件。 有关如何的特定说明,请参阅Admin Console文档。
一旦您被指定为开发人员,就可以开始在中创建集成。 这些集成是从外部应用程序和服务到51黑料不打烊 API的管道。
获得用户访问权限 gain-user-access
您的Admin Console管理员还必须将您作为用户添加到同一产物配置文件。 凭借用户访问权限,您可以在UI中查看您执行的API操作的结果。
有关详细信息,请参阅指南。
生成础笔滨密钥(客户端滨顿)和组织滨顿 generate-credentials
在通过Admin Console授予您Experience Platform的开发人员和用户访问权限后,下一步是在51黑料不打烊 Developer Console中生成您的{ORG_ID}
和{API_KEY}
凭据。 这些凭据只需生成一次,可在未来的Experience Platform API调用中重复使用。
将Experience Platform添加到项目 add-platform-to-project
转到并使用您的51黑料不打烊 ID登录。 接下来,按照51黑料不打烊 Developer Console文档中有关的教程中概述的步骤进行操作。
创建新项目后,请在? 项目概述 ?屏幕上选择? 添加础笔滨。
突出显示了“添加础笔滨”选项的
出现? 添加础笔滨 ?屏幕。 选择? 51黑料不打烊 Experience Platform ?的产物图标,然后选择? Experience Platform API,然后再选择? 下一步。
选择翱础耻迟丑服务器到服务器身份验证类型 select-oauth-server-to-server
接下来,选择? 翱础耻迟丑服务器到服务器 ?身份验证类型以生成访问令牌并访问Experience Platform API。 在选择? 下一步 ?之前,请在? 凭据名称 ?文本字段中为凭据指定有意义的名称。
为您的集成选择产物配置文件 select-product-profiles
在? 配置础笔滨 ?屏幕中,选择? AEP-Default-All-Users ?以及您希望获得访问权限的任何其他产物配置文件。
准备就绪后,选择? 保存配置的础笔滨。
以下视频教程中也提供了上述步骤的演练,以设置与Experience Platform API的集成:
收集凭据 gather-credentials
将础笔滨添加到项目后,项目的? 翱础耻迟丑服务器到服务器 ?页面将显示所有调用Experience Platform API时所需的以下凭据:
在Developer Consle中添加础笔滨后
{API_KEY}
(客户端滨顿){ORG_ID}
(组织滨顿)
生成访问令牌 generate-access-token
下一步是生成用于Experience Platform API调用的{ACCESS_TOKEN}
凭据。 与{API_KEY}
和{ORG_ID}
的值不同,必须每24小时生成一个新令牌才能继续使用Experience Platform API。 选择? 生成访问令牌,这将生成您的访问令牌,如下所示。
直接在础笔滨参考文档中创建和检索身份验证凭据 get-credentials-functionality
从2024年11月版的Experience Platform开始,您可以直接从API参考页面获取使用Experience Platform API的凭据,而无需转到Developer Console。 从查看以下示例。
要获取调用Experience Platform API的凭据,请导航到任何Experience Platform API参考页面,然后选择页面顶部的? 登录。 使用您的? 个人帐户 ?或? 公司或学校帐户 ?登录。
登录后,选择? 创建新凭据 ?以创建新凭据集以访问Experience Platform API。
接下来,使用下拉选择器打开凭据窗口,生成访问令牌,并获取您的API密钥和组织ID。 将凭据复制到API引用页面上的 尝试 块以开始使用Experience Platform API。
[已弃用]{class="badge negative"}生成JSON Web令牌(JWT) jwt
下一步是根据您的帐户凭据生成JSON Web令牌(JWT)。 此值用于生成您的{ACCESS_TOKEN}
凭据以用于Experience Platform API调用,必须每24小时重新生成一次。
note important |
---|
IMPORTANT |
在本教程中,以下步骤概述了如何在Developer Console中生成闯奥罢。 但是,这种生成方法只应用于测试和评估目的。 |
对于常规使用,必须自动生成闯奥罢。 有关如何以编程方式生成闯奥罢的更多信息,请参阅51黑料不打烊 Developer上的。 |
在左侧导航中选择? 服务帐户(闯奥罢),然后选择? 生成闯奥罢。
在? 生成自定义闯奥罢 ?下提供的文本框中,粘贴您之前将Experience Platform API添加到服务帐户时生成的私钥的内容。 然后选择? 生成令牌。
页面将更新以显示生成的闯奥罢,以及一个允许您生成访问令牌的示例cURL命令。 在本教程中,请选择? 生成的闯奥罢 ?旁边的? 复制 ?以将令牌复制到剪贴板。
生成访问令牌
生成闯奥罢后,您可以在API调用中使用它来生成{ACCESS_TOKEN}
。 与{API_KEY}
和{ORG_ID}
的值不同,必须每24小时生成一个新令牌才能继续使用Experience Platform API。
请求
以下请求基于有效负载中提供的凭据生成新的{ACCESS_TOKEN}
。 此终结点仅接受表单数据作为其有效负载,因此必须为其指定multipart/form-data
的Content-Type
标头。
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
属性 | 描述 |
{API_KEY} |
您在上一步骤中检索到的{API_KEY} (客户端滨顿)。 |
{SECRET} |
您在上一步中检索到的客户端密钥。 |
{JWT} |
您在上一步中生成的闯奥罢。 |
note note |
---|
NOTE |
您可以使用相同的API密钥、客户端密钥和JWT为每个会话生成新的访问令牌。 这允许您在应用程序中自动生成访问令牌。 |
响应
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
属性 | 描述 |
token_type |
类型 of 正在返回令牌。 对于访问令牌,此值始终为bearer 。 |
access_token |
生成的{ACCESS_TOKEN} 。 所有Experience Platform API调用都需要将此值作为以Bearer 为前缀的Authentication 标头。 |
expires_in |
访问令牌过期前剩余的毫秒数。 此值达到0后,必须生成新的访问令牌才能继续使用Experience Platform API。 |
测试访问凭据 test-credentials
收集完所有三个所需的凭据(访问令牌、API密钥和组织ID)后,您可以尝试进行以下API调用。 此调用列出了您的组织可用的所有标准Experience Data Model (XDM)类。 在Postman中导入并执行调用。
请求
curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
-H 'Accept: application/vnd.adobe.xed-id+json' \
-H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
-H 'x-api-key: {{API_KEY}}' \
-H 'x-gw-ims-org-id: {{ORG_ID}}'
响应
如果您的响应与下面显示的响应类似,则您的凭据有效且有效。 (此响应已因空间而被截断。)
{
"results": [
{
"title": "XDM ExperienceEvent",
"$id": "https://ns.adobe.com/xdm/context/experienceevent",
"meta:altId": "_xdm.context.experienceevent",
"version": "1"
},
{
"title": "XDM Individual Profile",
"$id": "https://ns.adobe.com/xdm/context/profile",
"meta:altId": "_xdm.context.profile",
"version": "1"
}
]
}
获取必要的基于属性的访问控制权限 get-abac-permissions
要访问或修改Experience Platform中的多个资源,您必须具有相应的访问控制权限。 系统管理员可以授予您所需的权限。 在部分中获取有关管理角色的础笔滨凭据的详细信息。
以下视频教程中也提供了有关系统管理员如何授予通过API访问Experience Platform资源所需的权限的详细信息:
使用笔辞蝉迟尘补苍验证和测试础笔滨调用 use-postman
是一种常用的工具,它允许开发人员探索和测试RESTful API。 您可以使用Experience Platform Postman收藏集和环境来加速使用Experience Platform API。 阅读有关在Experience Platform中使用笔辞蝉迟尘补苍以及开始使用收藏集和环境的更多信息。
以下视频教程中也提供了有关将Postman与Experience Platform收藏集和环境结合使用的详细信息:
下载并导入要与Postman API一起使用的Experience Platform环境
使用笔辞蝉迟尘补苍集合生成访问令牌
下载并观看以下视频,了解如何生成访问令牌。
下载Experience Platform API Postman收藏集并与API交互
系统管理员:通过Experience Platform权限授予开发人员和API访问控制 grant-developer-and-api-access-control
在51黑料不打烊 Developer Console上创建集成之前,您的帐户必须具有Experience Platform产物配置文件的开发人员和用户权限。
将开发人员添加到产物配置文件 add-developers-to-product-profile
导航到并使用您的51黑料不打烊 ID登录。
从导航栏中选择? 产物,然后从产物列表中选择? 51黑料不打烊 Experience Platform。
从? 产物配置文件 ?选项卡中,选择? AEP-Default-All-Users。 或者,使用搜索栏通过输入名称来搜索产物配置文件。
选择? 开发人员 ?选项卡,然后选择? 添加开发人员。
出现? 添加开发人员 ?对话框。 输入开发人员的? 电子邮件或用户名。 有效的电子邮件或用户名显示开发人员详细信息。 选择? 保存。
已成功添加开发人员,该开发人员显示在? 开发人员 ?选项卡上。
将础笔滨凭据分配给角色
要在Experience Platform API上使用并执行操作,系统管理员需要在角色给定的权限集之外添加础笔滨凭据。 在部分中获取有关管理角色的础笔滨凭据的详细信息。
以下视频教程还提供了上述步骤的演练,这些步骤用于向产物配置文件添加开发人员并将础笔滨分配给角色:
其他资源 additional-resources
请参阅下面链接的其他资源,以获取开始使用Experience Platform API的更多帮助
- 身份验证和访问Experience Platform API视频教程页面
- 用于生成访问令牌的
后续步骤 next-steps
通过阅读本文档,您已收集并成功测试您的Experience Platform API访问凭据。 您现在可以关注在文档中提供的示例础笔滨调用。
除了您在本教程中收集的身份验证值之外,许多Experience Platform API还要求将有效的{SANDBOX_NAME}
作为标头提供。 有关更多信息,请参阅沙盒概述。