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调用 中。

我的IMS组织是什么?

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

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

所有API请求中都需要API密钥作为标头。 可通过 Adobe开发人员控制台. 在控制台中, 集成 选项卡,导航到 概述 部分,您将在 客户端凭据. 有关如何验证的分步说明 Platform,请参阅 身份验证教程.

如何获取访问令牌?

所有API调用的授权标头中都需要使用访问令牌。 它们可以使用 curl 命令,前提是您有权访问IMS组织的集成。 访问令牌仅在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?

邮递员 是一种将对RESTful API的调用可视化的有用工具。 的 Platform API快速入门指南 包含有关导入Postman集合的视频和说明。 此外,还提供每项服务的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开发人员指南子指南 过滤数据 了解更多。) 再次尝试请求前等待片刻,如果问题仍然存在,请与管理员联系。

请求标头错误

中的所有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-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"
}

当IMS组织标头(x-gw-ims-org-id)。 再次尝试之前,请确保标头包含在IMS组织的ID中。

配置文件无效

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

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

未指定有效的content-type

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

以下两种情况中的一种情况会显示此错误消息:

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

服务疑难解答目录

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

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

流摄取疑难解答指南
Adobe Experience Platform数据科学工作区 Sensei Machine Learning API Data Science Workspace 疑难解答指南
Adobe Experience Platform数据管理 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 沙箱疑难解答指南

在此页面上