增强的错误代码 enhanced-error-codes
增强的错误代码表示Adobe Pass身份验证功能,该功能向与集成的客户端应用程序提供其他错误信息:
-
Adobe Pass身份验证REST API:
-
Adobe Pass身份验证SDK预授权API:
(*) Preauthorize API是唯一支持增强错误代码的Adobe Pass身份验证SDK API。
呈现 enhanced-error-codes-representation
增强的错误代码可以采用JSON
或XML
格式表示,具体取决于集成的Adobe Pass身份验证API和使用的“接受”标头值(即application/json
或application/xml
):
- 顶级错误信息:在这种情况下,"error" 对象位于顶级,因此响应正文只能包含***"error"***对象。
- 项级别错误信息:在这种情况下,"error" 对象位于项级别,因此对于在服务时遇到错误的所有项,响应正文可以包含***"error"***对象。
请参阅以下HTTP响应,其中包含表示为JSON
或XML
的增强错误代码示例。
code language-json |
---|
|
code language-xml |
---|
|
code language-json |
---|
|
code language-json |
---|
|
code language-json |
---|
|
增强的错误代码包括以下JSON
字段或XML
属性:
如果服务合作伙伴不提供任何自定义消息,则此字段可能不存在。
此字段包含绝对URL,不应从错误代码推断,根据错误上下文,可以提供不同的URL。
操作 enhanced-error-codes-representation-action
增强的错误代码包括一个“action”字段,该字段提供了可能纠正此情况的推荐操作。
“action”字段的可能值包括:
(*)对于某些错误,多个操作可能是可能的解决方案,但“action”字段指示修复错误的概率最高的操作。
状态 enhanced-error-codes-representation-status
增强的错误代码包含一个“状态”字段,该字段指示与错误关联的HTTP状态代码。
“status”字段的可能值包括:
当客户端生成错误并且大多数时间这意味着客户端需要额外的操作来修复它时,通常会显示带有4xx“状态”的增强错误代码。
具有5xx“状态”的增强型错误代码通常在服务器生成错误时出现,大多数情况下,这意味着服务器需要额外的工作来修复错误。
代码 enhanced-error-codes-representation-code
增强的“错误代码”包含一个“代码”字段,该字段提供与错误关联的Adobe Pass身份验证唯一标识符。
基于集成的Adobe Pass身份验证API,“代码”字段的可能值汇总在两个列表中低于。
列表 enhanced-error-codes-lists
REST API v1 enhanced-error-codes-lists-rest-api-v1
下表列出了客户端应用程序在与Adobe Pass身份验证REST API v1集成时可能遇到的增强错误代码。
SDK预授权API enhanced-error-codes-lists-sdks-preauthorize-api
有关客户端应用程序在与Adobe Pass Authentication SDK预授权API集成时可能遇到的增强错误代码,请参阅上一个部分。
REST API v2 enhanced-error-codes-lists-rest-api-v2
下表列出了客户端应用程序在与Adobe Pass身份验证REST API v2集成时可能遇到的增强错误代码。
响应处理 enhanced-error-codes-response-handling
总之,在处理包含增强型错误代码的响应时,应考虑以下事项:
-
检查两个状态值:始终检查HTTP响应状态代码和增强型错误代码“状态”字段。 它们可能有所不同,并且都提供了宝贵的信息。
-
与顶级和项级错误信息无关:处理与传递方式无关的顶级和项级错误信息,确保可以处理两种形式的传输增强型错误代码。
-
重试逻辑:对于需要重试的错误,请确保通过指数回退完成重试,以避免使服务器不堪重负。 此外,如果是Adobe Pass身份验证API同时处理多个项目(例如,预授权API),您应在重复请求中仅包含标记为“重试”的项目,而不包含整个列表。
-
配置更改:对于需要配置更改的错误,请确保在启动新应用程序或新功能之前进行必要的更改。
-
身份验证和授权:对于与身份验证和授权相关的错误,必须提示用户根据需要重新身份验证或获取新授权。
-
用户反馈:可选,使用人类可读的“消息”和(可能的)“详细信息”字段通知用户该问题。 “详细信息”文本消息可能会从MVPD预授权或授权端点传递,或在应用降级规则时从程序员传递。