Authenticate and access Experience Platform APIs

This document provides a step-by-step tutorial for gaining access to an Adobe Experience Platform developer account in order to make calls to Experience Platform APIs.

进行身份验证以进行API调用

为了维护应用程序和用户的安全性,对Adobe I/OAPI的所有请求都必须使用OAuth和JSON Web令牌(JWT)等标准进行身份验证和授权。 然后,JWT与客户特定信息一起使用,以生成您的个人访问令牌。

本教程介绍通过创建流程图中概述的访问令牌进行身份验证的步骤:

先决条件

为了成功调用API, Experience Platform 您需要:

  • 一个可进入Adobe Experience Platform的国际管理系统组织
  • 注册的Adobe ID帐户
  • Admin Console管理员将您添加为 开发 和产品用户。

以下部分介绍创建Adobe ID并成为组织的开发人员和用户的步骤。

创建Adobe ID

如果您没有Adobe ID,可以使用以下步骤创建一个:

  1. 转到 Adobe开发人员控制台
  2. 单击 创建新帐户
  3. 完成注册过程

成为组织的开发人 Experience Platform 员和用户

在Adobe I/O创建集成之前,您的帐户必须对IMS组织中的某个产品具有开发人员权限。 有关该Admin Console的开发人员帐户的详细信息,请参阅 支持文档 ,以管理开发人员。

获得开发人员访问权限

请与您 Admin Console 组织中的管理员联系,以使用将您添加为您组织的某个产品的开发人员 Admin Console

管理员必须将您指定为开发人员,以便至少让一个产品用户档案继续。

一旦您被分配为开发人员,您将拥有在Adobe I/O创建集成的访 问权。 这些集成是从外部应用程序和服务到AdobeAPI的管道。

获得用户访问权限

您的 Admin Console 管理员还必须以用户身份将您添加到产品中。

与添加开发人员的过程类似,管理员必须将您分配给至少一个产品用户档案才能继续。

在Adobe开发人员控制台中生成访问凭据

NOTE

如果您正在从文档开发人 员指南中遵循此Privacy Service,您现在可以返回该指南以生成特定于的访问凭据 Privacy Service。

使用Adobe开发人员控制台,您必须生成以下三个访问凭据:

  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}

{IMS_ORG}{API_KEY} 只需生成一次,以后的API调用中 Platform 可重用。 但是,您的计 {ACCESS_TOKEN} 划是临时的,必须每24小时再生一次。

下面详细介绍了这些步骤。

一次性设置

转到 Adobe开发人 员控制台并登录您的Adobe ID。 接下来,按照Adobe开发人员控制台文档中 有关创建空项目 的教程中概述的步骤操作。

创建新项目后,单击“项 目概述 ”屏 幕上的“添加API ”。

现添加API 屏幕。 单击Adobe Experience Platform的产品图标,然后选择 Experience PlatformAPI ,然后单 击Next

选择要添加 Experience Platform 到项目的API后,请按照教程中介绍的步 骤,使用服务帐户(JWT) (从“配置API”步骤开始)将API添加到项目以完成该过程。

将API添加到项目后,“项目 概述 ”页将显示对API的所有调用中所需的以 Experience Platform 下凭据:

  • {API_KEY} (客户端ID)
  • {IMS_ORG} (Organization ID)

每个会话的身份验证

您必须收集的最终所需凭据是您的 {ACCESS_TOKEN}。 与和的值 {API_KEY}{IMS_ORG}同,必须每24小时生成一个新令牌才能继续使用 Platform API。

要生成新代码, {ACCESS_TOKEN}请按照“开发人 员控制台凭据指南 ”中的步骤生成JWT令牌。

测试访问凭据

收集所有三个必需凭据后,您可以尝试进行以下API调用。 此调用将列表 Experience Data Model 模式注册表容器中的所有(XDM)类 global :

API格式

GET /global/classes

请求

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: {IMS_ORG}'

响应

如果您的响应与下面显示的响应类似,则您的凭据有效且有效。 (此响应已被截断,用于空间。)

{
  "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"
    }
  ]
}

使用Postman进行JWT身份验证和API调用

Postman 是使用REST风格的API的常用工具。 此 中篇文章 介绍如何设置邮递员以自动执行JWT身份验证,并使用它使用Adobe Experience PlatformAPI。

后续步骤

通过阅读此文档,您已收集并成功测试了API的访问凭 Platform 据。 您现在可以按照文档中提供的示例API调 用操作

除了在本教程中收集的身份验证值之外,许多 Platform API还要求以头 {SANDBOX_NAME} 形式提供有效的API。 See the sandboxes overview for more information.

在此页面上