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

本文档提供了有关Adobe Experience Platform的常见问题解答，以及有关在任意报表包中可能遇到的常见错误的高级故障排除指南 Experience Platform API。 有关个人疑难解答指南 Platform 服务，请参见 服务疑难解答目录 下。

常见问题解答

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

什么是 Experience Platform API？

Experience Platform 提供多个使用HTTP请求访问的RESTful API Platform 资源。 这些服务API每个都公开多个端点，并允许您执行列出(GET)、查找(GET)、编辑(PUT和/或PATCH)以及删除(DELETE)资源的操作。 欲知关于每项服务可用的特定端点和操作的更多信息，请参见 API参考文档 Adobe I/O时。

如何设置API请求的格式？

请求格式因 Platform 正在使用的API。 了解如何构建API调用结构的最佳方法是，特定的，请遵循文档中提供的示例 Platform 您正在使用的服务。

有关格式化API请求的更多信息，请访问Platform API快速入门指南 读取示例API调用 部分。

我的组织是什么？

组织是客户的Adobe表示形式。 任何许可的Adobe解决方案均集成到此客户机构。 当组织有权享有 Experience Platform，它可以向开发人员分配访问权限。 组织ID (x-gw-ims-org-id)表示应为其执行API调用的组织，因此需要将其作为所有API请求中的标头。 此ID可通过 Adobe Developer控制台：在 集成 选项卡，导航到 概述 部分，了解如何在任何特定集成下查找ID 客户端凭据. 有关如何在中进行身份验证的分步说明 Platform，请参见 身份验证教程.

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

在所有API请求中，都需要API密钥作为标头。 您可以通过 Adobe Developer控制台. 在控制台中， 集成 选项卡，导航到 概述 部分，您将在下找到键 客户端凭据. 有关如何向进行身份验证的分步说明 Platform，请参见 身份验证教程.

如何获取访问令牌？

所有API调用的Authorization标头中都需要访问令牌。 只要您有权访问组织的集成，就可以使用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字段？

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

我能否使用Postman调用 Platform API？

Postman 是一个有用的工具，可将对RESTful API的调用可视化。 此 平台API快速入门指南 包含有关导入Postman收藏集的视频和说明。 此外，还提供了每个服务的Postman收藏集列表。

的系统要求是什么 Platform？

根据您使用的是UI还是API，将应用以下系统要求：

对于基于UI的操作：

• 一种现代化的标准网络浏览器。 而最新版本的 Chrome 推荐，当前和以前的主要版本 Firefox， Internet Explorer还支持、和Safari。
  • 每次发布新的主要版本时， Platform 开始支持最新版本，而不再支持第三个最新版本。
• 所有浏览器都必须启用Cookie和JavaScript。

对于API和开发人员交互：

• 要为REST、流和Webhook集成开发的开发环境。

错误和故障排除

以下是使用任意 Experience Platform 服务。 有关个人疑难解答指南 Platform 服务，请参见 服务疑难解答目录 下。

API状态代码

在任何 Experience Platform API。 每种原因都各不相同，因此本节中给出的解释具有一般性。 有关个人中特定错误的更多详细信息 Platform 服务，请参阅 服务疑难解答目录 下。

请求标头错误

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

OAuth令牌缺失

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

出现以下错误消息时 Authorization api请求中缺少标头。 在重试之前，请确保授权标头包含有效访问令牌。

OAuth令牌无效

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

当提供的访问令牌位于以下位置时，显示此错误消息： Authorization 标头无效。 确保已正确输入令牌，或 生成新令牌 在Adobe I/O控制台中。

需要API密钥

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

当API密钥标头(x-api-keyAPI请求中缺少。 在重试之前，请确保标头包含有效的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"
}

此错误消息在组织标题(x-gw-ims-org-idAPI请求中缺少。 在重试之前，请确保标头包含在组织的ID中。

配置文件无效

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

当用户或Adobe I/O集成（由标识） 访问令牌 在 Authorization 标头)无权调用 Experience Platform 中提供的组织的API x-gw-ims-org-id 标题。 在重试之前，请确保已在标头中为您的组织提供了正确的ID。 如果您不知道自己的组织ID，可以在 Adobe I/O控制台：在 集成 选项卡，导航到 概述 部分，以便在其中查找ID 客户端凭据.

刷新etag错误

{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}

如果其他API调用方更改了任何源或目标实体（如流、连接、源连接器或目标连接），您可能会收到etag错误。 由于版本不匹配，您尝试进行的更改将不会应用于实体的最新版本。

要解决此问题，需要再次获取实体，确保更改与实体的新版本兼容，然后将新标签放入 If-Match 标头，最后进行API调用。

未指定有效的内容类型

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

当POST、PUT或PATCH请求无效或丢失时，显示此错误消息 Content-Type 标题。 确保请求中包含标头，且其值为 application/json.

缺少用户区域

{
    "error_code": "403027",
    "message": "User region is missing"
}

此错误消息在以下两种情况之一中显示：

• 当组织ID标头不正确或格式错误时(x-gw-ims-org-id)在API请求中传递。 在重试之前，请确保包含组织的正确ID。
• 当您的帐户（由提供的身份验证凭据表示）未与Experience Platform的产品配置文件关联时。 按照上的步骤操作 生成访问凭据 在Platform API身份验证教程中，将Platform添加到您的帐户并相应地更新身份验证凭据。

服务疑难解答目录

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