本指南介绍 Adobe Customer Journey Analytics (CJA) API,详细讲解了数据提取、自定义解决方案以及第三方集成。其中包括访问设置、API 密钥、使用 Postman 进行测试、API 调用的分步示例,以及针对首次用户的提示。

您是否刚开始使用 API,并且想知道 Adobe Customer Journey Analytics (CJA) API 能如何帮助您?别担心!在这份适合初学者的指南中,我们将为您介绍基础要点,解析专业术语,并帮助您迈出进入令人兴奋的 CJA API 世界的第一步。

想象一下,能够以编程方式访问和分析 CJA 数据,而无需手动操作。这正是 CJA API 能帮助您做到的!

将 API 理解成信使,它们负责将您的请求传送到 Adobe 服务器,并以整齐的封装带回结果。

做好成功准备

在进行第一次 API 调用之前,您需要设置适当的访问和权限。首先,确保您已被添加为所在组织的开发人员。然后,验证您是否拥有产品配置文件的访问权限以及相关的必要权限。

步骤 1:获取 API 密钥
  1. 登录 Adobe Developer Console
  2. 创建新项目,并将 Customer Journey Analytics API 添加到您的项目,然后选择所需的产品配置文件。
  3. 点击 “添加到项目” 并将 Adobe Experience Platform API 也添加到项目中
  4. 设置完成后,您将能够在左侧的 “凭据” 选项卡下获取所需的全部信息。

以下是所有 API 请求所需的三个基本标头参数

务必保存这些凭据,它们是解锁 API 功能的钥匙!CJA API 的快速入门部分包含更详细的分步说明。

步骤 2:测试设置

使用 Postman 这一功能强大且用户友好的工具即可很好地测试 API,无需编写任何代码。启动应用程序后,您可以轻松地导入 API 凭据,并开始使用简单的 GET 请求进行试验,以验证连接和身份验证是否正常。建议您从 GET 请求开始 API 测试之旅,因为这是公认较为安全且无破坏性的,它们只是从服务器检索数据,而不会进行任何修改。这不同于其他 HTTP 方法(如 POST、PUT 或 DELETE 请求),后者可能会更改或删除服务器上的数据,因此在测试时应更加谨慎。

进行第一次 API 调用

让我们做些简单的事情:获取 CJA 帐户中可用数据视图的列表。

示例:列出数据视图

端点:
GET https://cja.adobe.io/data/dataviews

标头:

x-api-key: {API_KEY}

x-gw-ims-org-id: {IMS_ORG_ID}

Authorization: Bearer {AUTHORIZATION_TOKEN}

CURL 请求:

curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\

-H "x-api-key: {API_KEY}" \

-H "x-gw-ims-org-id: {IMS_ORG_ID}" \

-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"

您也可以在CJA API端点文档中使用 “尝试” 功能来尝试这些请求。以下是尝试上述请求的链接

只需点击 “尝试” CTA 并输入所有必填参数,在本例中就是我们讨论过的标头参数,然后点击 “发送”。

您也可以包含其他参数来自定义您的请求。在 CJA API 文档中,每个 API 请求的 “查询参数” 部分下可以找到可用参数的列表。

以下是使用 API 时会遇到的关键 HTTP 响应代码:

这些状态代码可准确地告诉开发人员在 API 请求期间发生了什么,从而简化问题的排查。

NOTE
使用 “尝试” 功能时,请确保“Authorization”字段中的访问令牌带有“Bearer”前缀。省略或拼错此前缀会导致 401 错误。

针对首次用户的提示

  1. 验证您的访问权限: 确保您拥有正确的权限级别,并且您已被添加到正确的产品配置文件中。没有正确的访问权限是 API 请求失败时最常见的根本原因。
  2. 测试,测试,再测试: 在编写代码之前,使用 API 端点文档中的 “尝试” 功能或 Postman 来测试请求。
  3. 从小规模起步: 从简单的 GET 请求开始,逐步进展到 POST 查询。
  4. 使用文档: Adobe 的 CJA API 文档是您最好的帮手。定期检查更新,因为在重大更新后,旧配置可能无法正常工作。
  5. 提问: 请随时联系 Experience League Adobe Analytics 社区寻求帮助。

开始使用 Adobe CJA API 一开始可能看起来令人生畏,但通过一定的练习,您很快就能实现工作流程自动化并发现洞察。所以,请迈出第一步——登录,获取您的凭据,然后尝试一个简单的 API 调用。您的 API 冒险正等待开启!

5 分钟