本指南涵盖 Adobe Customer Journey Analytics (CJA) API，详细介绍数据提取、自定义解决方案及第三方集成。内容包括访问设置、API 密钥、使用 Postman 进行测试、API 调用操作示例，以及为首次使用者准备的提示。
您是 API 新手，并且想了解Adobe Customer Journey Analytics (CJA) API如何助力您的业务吗？请放心！在这份面向初学者的指南中，我们将为您详细讲解基础知识，解释相关术语，帮助您迈出探索 CJA API 世界的第一步。
想象一下，您可以通过编程方式访问并分析 CJA 数据，无需手动操作。这正是 CJA API 为您带来的强大能力！
- 高效提取数据：通过 API 调用简化数据提取流程。
- 构建自定义解决方案：设计并实现满足特定业务需求的自动化报表流程。
- 无缝连接集成：通过强大的集成能力，实现 CJA 与第三方应用之间的数据顺畅流转。
您可以将 API 想象成信使——它们会将您的请求传递到 Adobe 的服务器，并以有条理的方式将结果带回。
成功准备
在进行您的第一次 API 调用之前，您需要先设置好相应的访问权限。首先，请确保您已被添加为组织的开发者。然后，确认您已获得所需权限的产品配置文件访问权限。
步骤 1：获取您的 API 密钥
- 登录 Adobe Developer Console。
- 创建新项目，并将 Customer Journey Analytics API 添加到您的项目中，同时选择所需的产品配置文件。
- 点击 添加到项目，并将 Adobe Experience Platform API 也添加到该项目中。
- 完成设置后，您可以在左侧的 凭据 标签下获取所有所需信息。
以下是所有 API 请求所需的三个必填请求头参数：
- Access Token（访问令牌）——确保只有授权用户可以访问数据，您可以通过点击屏幕快照中高亮显示的 Generate access token 按钮生成。该参数在 API 请求中被称为 Authorization（授权） 参数。
- Client ID（也称为 API Key）——在 API 请求中被称为 x-api-key。
- Organization ID——在 API 请求中被称为 x-gw-ims-org-id。
请务必妥善保存这些凭据——它们是您解锁 API 强大功能的钥匙！如需更详细的分步操作说明，请参阅 CJA API 的快速入门部分。
步骤 2：测试您的设置
如果您希望在无需编写代码的情况下测试 API，推荐使用功能强大且易于使用的 Postman 工具。启动应用程序后，您可以轻松导入 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 端点文档中，使用 Try It 功能直接尝试这些请求。点击此链接可尝试上述请求。
只需点击 Try It CTA，并输入所有必填参数，在本例中为我们前面讨论过的标头参数，然后点击 Send。
您还可以添加其他参数，以自定义您的请求。每个 API 请求下的 Query Parameters 分区中，您可以在 CJA API documentation 查找可用参数列表。
以下是您在使用 API 时会遇到的主要 HTTP 状态代码：
- 200：成功 — 服务器已成功处理请求并返回数据
- 404：未找到 — 服务器无法找到所请求的资源
- 500：内部服务器错误 — 服务器端发生错误
这些状态代码能够让开发者清楚了解 API 请求过程中发生的情况，从而更便于排查问题。
首次使用 API 的用户指南
- 验证您的访问权限：请确保您拥有正确的权限级别，并已被添加到相应的产品配置文件中。访问权限不足是导致 API 请求失败的最常见原因。
- 多次测试：建议您在编写代码前，利用 API 端点文档中的 Try It 功能或 Postman 工具，先行尝试发送请求。
- 从简单入手：建议先从基础的 GET 请求开始，逐步过渡到 POST 查询。
- 充分利用文档：Adobe 的 CJA API documentation 是您最可靠的助手。请定期关注文档更新，因为在重大升级后，部分旧配置可能无法如预期工作。
- 积极提问：如有疑问，欢迎随时在 Experience League Adobe Analytics Community 社区寻求帮助。
刚开始接触 Adobe CJA API 时，您可能会觉得有些复杂，但只要多加练习，您很快就能实现自动化流程并挖掘数据洞察。请勇敢迈出第一步——登录系统，获取您的凭据，尝试一次简单的 API 调用。您的 API 探索之旅即将开启！