Platform 常见问题解答和疑难解答指南

本文档提供有关Adobe Experience Platform的常见问题解答,以及针对任何Experience Platform API中可能遇到的常见错误的高级疑难解答指南。 有关各个Platform服务的疑难解答指南,请参阅以下服务疑难解答目录

常见问题解答

以下是有关Adobe Experience Platform的常见问题解答列表。

什么是Experience Platform API?

Experience Platform 优惠使用HTTP请求访问资源的多个RESTful Platform API。这些服务API每个都公开多个端点,并允许您对列表(GET)、查找(GET)、编辑(PUT和/或PATCH)和删除(DELETE)资源执行操作。 有关每个服务可用的特定端点和操作的详细信息,请参阅有关Adobe I/O的API参考文档

如何设置API请求的格式?

请求格式因使用的Platform API而异。 了解如何构造API调用的最佳方式是按照您所使用的特定Platform服务文档中提供的示例进行操作。

有关创建API请求的详细信息,请访问平台API快速入门指南阅读示例API调用部分。

我的IMS组织是什么?

IMS组织是Adobe的代表。 任何许可的Adobe解决方案都与此客户组织集成。 当IMS组织有权访问Experience Platform时,它可以将访问权限分配给开发人员。 IMS组织ID(x-gw-ims-org-id)表示应执行API调用的组织,因此在所有API请求中都要求作为头。 可通过Adobe开发人员控制台找到此ID:在​集成​选项卡中,导航至任何特定集成的​概述​部分,以在​客户端凭据​下查找ID。 有关如何验证到Platform的分步演练,请参阅验证教程

在哪里可以找到我的API密钥?

所有API请求中都需要API密钥作为头。 它可以通过Adobe开发者控制台找到。 在控制台中,在​Integrations​选项卡上,导航到特定集成的​Overview​部分,您将在​Client Credentials​下找到密钥。 有关如何验证到Platform的分步演练,请参阅验证教程

如何获得访问令牌?

访问令牌在所有API调用的“授权”标头中是必需的。 如果您有权访问IMS组织的集成,则可使用curl命令生成这些组件。 访问令牌仅在24小时内有效,此后必须生成新令牌才能继续使用API。 有关生成访问令牌的详细信息,请参阅身份验证教程

如何使用查询参数?

某些Platform API端点接受查询参数以查找特定信息并过滤响应中返回的结果。 查询参数用问号(?)符号附加到请求路径,后跟使用格式paramName=paramValue的一个或多个查询参数。 在单个调用中组合多个参数时,必须使用&符号(&)分隔单个参数。 以下示例演示了如何使用多个查询参数的请求在文档中的表示方式。

常用查询参数的示例包括:

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

有关特定服务或端点可使用哪些查询参数的详细信息,请查阅特定于服务的文档。

如何在PATCH请求中指示要更新的JSON字段?

Platform API中的许多PATCH操作使用JSON指针字符串指示要更新的JSON属性。 这些值通常包含在使用JSON Patch格式的请求负载中。 有关这些技术所需语法的详细信息,请参阅API基础指南

我是否可以使用Postman对Platform API进行调用?

Postman 是一个用于对RESTful API进行可视化调用的有用工具。平台API快速入门指南包含有关导入Postman集合的视频和说明。 此外,还为每项服务提供邮递员集合列表。

Platform有哪些系统要求?

根据您是使用UI还是API,系统要求如下:

对于基于UI的操作:

  • 现代、标准的Web浏览器。 虽然建议使用Chrome的最新版本,但还支持Firefox、Internet Explorer和Safari的当前版本和以前的主要版本。
    • 每次发布新的主要版本时,Platform支持最新版本的开始将被放弃,而支持第三个最新版本。
  • 所有浏览器都必须启用Cookie和JavaScript。

对于API和开发人员交互:

  • 用于为REST、流和Webhook集成进行开发的开发环境。

错误和疑难解答

以下是使用任何Experience Platform服务时可能遇到的错误列表。 有关各个Platform服务的疑难解答指南,请参阅以下服务疑难解答目录

API状态代码

在任何Experience Platform API上都可能遇到以下状态代码。 每种解释都有各种原因,因此本节中的解释是一般性的。 有关单个Platform服务中的特定错误的详细信息,请参见下面的服务疑难解答目录

状态代码 描述 可能的原因
400 错误请求 请求构造不正确、缺少关键信息和/或包含不正确的语法。
401 身份验证失败 请求未通过身份验证检查。 您的访问令牌可能缺失或无效。 有关更多详细信息,请参阅下面的OAuth令牌错误部分。
403 禁止 已找到该资源,但您没有正确的凭据来视图它。
404 未找到 在服务器上找不到请求的资源。 资源可能已删除,或请求的路径输入不正确。
500 内部服务器错误 这是服务器端错误。 如果您同时发出多个调用,则可能达到API限制,并需要过滤结果。 (有关详细信息,请参阅筛选数据上的Catalog Service API开发人员指南子指南。) 请稍等片刻,然后再次尝试您的请求,如果问题仍然存在,请与管理员联系。

请求标头错误

Platform中的所有API调用都需要特定的请求标头。 要查看各个服务需要哪些标头,请参阅API参考文档。 要查找所需身份验证头的值,请参阅身份验证教程。 如果在进行API调用时,这些标头中的任何标头缺失或无效,则可能会发生以下错误。

缺少

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

当API请求中缺少Authorization标头时,将显示此错误消息。 在重试之前,请确保授权标头包含有效访问令牌。

OAuth令牌无效

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

Authorization标头中提供的访问令牌无效时,将显示此错误消息。 确保已正确输入令牌,或者在Adobe I/O控制台中生成新令牌

需要API密钥

{
    "error_code": "403000",
    "message": "Api Key is required"
}

当API请求中缺少API密钥头(x-api-key)时,将显示此错误消息。 在重试之前,请确保标头包含有效的API密钥。

API密钥无效

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

当提供的API密钥头(x-api-key)的值无效时,将显示此错误消息。 请确保在重试之前输入了正确的密钥。 如果您不知道您的API密钥,可以在Adobe I/O控制台中找到它:在​集成​选项卡中,导航至​概述​部分,以查找特定集成,以在​客户端凭据​下查找API密钥。

缺少标题

{
    "error_code": "400003",
    "message": "Missing header"
}

当API请求中缺少IMS组织头(x-gw-ims-org-id)时,将显示此错误消息。 在重试之前,请确保头包含在IMS组织的ID中。

用户档案无效

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

当用户或Adobe I/O集成(由Authorization标头中的访问令牌标识)无权对x-gw-ims-org-id标头中提供的IMS组织调用Experience Platform API时,将显示此错误消息。 在重试之前,请确保已在标头中为您的IMS组织提供了正确的ID。 如果您不知道您的组织ID,可以在Adobe I/O控制台中找到它:在​集成​选项卡中,导航至​概述​部分,以查找特定集成,以在​客户端凭据​下查找ID。

未指定有效的内容类型

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

当POST、PUT或PATCH请求的标头无效或缺少Content-Type标头时,将显示此错误消息。 请确保请求中包含标头,并且其值为application/json

服务疑难解答目录

以下是Experience Platform API的疑难解答指南和API参考文档的列表。 每个故障排除指南都针对特定于单个Platform服务的常见问题和问题提供解答。 API参考文档为每个服务的所有可用端点提供了全面指南,并显示您可能收到的示例请求主体、响应和错误代码。

服务 API 参考 故障诊断
访问控制 访问控制 API 访问控制疑难解答指南
Adobe Experience Platform数据摄取 Data Ingestion API 批量摄取疑难解答

指南流式摄取疑难解答指南
Adobe Experience Platform Data Science Workspace Sensei Machine Learning API Data Science Workspace 疑难解答指南
Adobe Experience Platform Data Governance Policy Service API
Adobe Experience Platform Identity Service Identity Service API Identity Service 疑难解答指南
Adobe Experience Platform查询服务 Query Service API Query Service 疑难解答指南
Adobe Experience Platform Segmentation Segmentation API
Catalog Service Catalog Service API
Experience Data Model (XDM) Schema Registry API XDM System 常见问题解答和疑难解答指南
Flow Service (Sources 和 Destinations) Flow Service API
Real-time Customer Profile Real-time Customer Profile API Profile 疑难解答指南
沙盒 沙箱API 沙箱疑难解答指南

在此页面上

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free