향상된 오류 코드 enhanced-error-codes
향상된 오류 코드는 다음과 통합된 클라이언트 애플리케이션에 추가 오류 정보를 제공하는 Adobe Pass 인증 기능을 나타냅니다.
-
Adobe Pass 인증 REST API:
-
Adobe Pass 인증 SDK가 API 사전 권한을 부여합니다.
(*) 사전 인증 API는 향상된 오류 코드를 지원하는 유일한 Adobe Pass 인증 SDK API입니다.
표시 enhanced-error-codes-representation
향상된 오류 코드는 통합 Adobe Pass 인증 API 및 사용된 "Accept" 헤더 값(예: JSON
또는 XML
)에 따라 application/json
또는 application/xml
형식으로 나타낼 수 있습니다.
- 최상위 오류 정보: 이 경우 "error" 개체가 최상위 수준에 있으므로 응답 본문에는 "error" 개체만 포함될 수 있습니다.
- 항목 수준 오류 정보: 이 경우 "error" 개체가 항목 수준에 있으므로 응답 본문에는 서비스 중에 오류가 발생한 모든 항목에 대한 "error" 개체가 포함될 수 있습니다.
REST API v2
REST API v2에 적용 가능한 향상된 오류 코드 예 JSON
이(가) 포함된 다음 HTTP 응답을 참조하십시오.
code language-json |
---|
|
code language-json |
---|
|
REST API v1
REST API v1에 적용할 수 있는 향상된 오류 코드 예 JSON
또는 XML
이(가) 포함된 다음 HTTP 응답을 참조하세요.
code language-json |
---|
|
code language-json |
---|
|
code language-xml |
---|
|
구조 enhanced-error-codes-representation-structure
향상된 오류 코드에는 다음 JSON
필드 또는 예가 있는 XML
특성이 포함되어 있습니다.
) 서비스 파트너가 사용자 지정 메시지를 제공하지 않는 경우 이 필드가 없을 수 있습니다.
이 필드에는 절대 URL이 있으며 다른 URL을 제공할 수 있는 오류 컨텍스트에 따라 오류 코드에서 유추해서는 안 됩니다.
액션 enhanced-error-codes-representation-action
향상된 오류 코드에는 상황을 수정할 수 있는 권장 작업을 제공하는 "작업" 필드가 포함되어 있습니다.
"작업" 필드에 사용할 수 있는 값은 다음과 같습니다.
(*) 일부 오류의 경우 여러 작업이 가능한 해결 방법일 수 있지만, "작업" 필드는 오류를 수정할 가능성이 가장 높은 작업을 나타냅니다.
상태 enhanced-error-codes-representation-status
향상된 오류 코드에는 오류와 연관된 HTTP 상태 코드를 나타내는 "status" 필드가 포함되어 있습니다.
"상태" 필드에 사용할 수 있는 값은 다음과 같습니다.
4xx "status"가 있는 향상된 오류 코드는 일반적으로 클라이언트가 오류를 생성할 때 나타나며 대부분의 경우 클라이언트가 이를 해결하기 위해 추가 작업이 필요함을 나타냅니다.
5xx "status"가 있는 향상된 오류 코드는 일반적으로 서버에서 오류가 생성될 때 표시되며 대부분의 경우 서버에서 오류를 해결하기 위해 추가 작업이 필요하다는 의미입니다.
코드 enhanced-error-codes-representation-code
향상된 오류 코드에는 오류와 관련된 Adobe Pass 인증 고유 식별자를 제공하는 "코드" 필드가 포함됩니다.
"code" 필드에 대해 가능한 값은 통합된 Adobe Pass 인증 API를 기반으로 두 목록에서 아래로 집계됩니다.
목록 enhanced-error-codes-lists
REST API v2 enhanced-error-codes-lists-rest-api-v2
아래 표에는 Adobe Pass 인증 REST API v2와 통합할 때 클라이언트 애플리케이션에서 발생할 수 있는 향상된 오류 코드가 나와 있습니다.
(기존) 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 인증 SDK 사전 권한 부여 API와 통합할 때 클라이언트 응용 프로그램에 발생할 수 있는 향상된 오류 코드에 대해 이전 섹션을 참조하세요.
응답 처리 enhanced-error-codes-response-handling
요약하면 향상된 오류 코드가 포함된 응답을 처리할 때는 다음 사항을 고려해야 합니다.
-
오류를 반환하는 API에 대해 불가지론적: API에서 생성되는 오류 코드에 관계없이 향상된 오류 코드의 전체 카탈로그를 지원하는 중앙 집중식 오류 처리 논리를 구현합니다. 여러 향상된 오류 코드는 API에서 공유되며 일관되게 처리되어야 합니다.
-
최상위 오류 정보와 항목 수준 오류 정보 불가지론자: 전달되는 방식에 따라 최상위 및 항목 수준 오류 정보를 불가지론자로 처리하고 향상된 오류 코드를 전송하는 두 가지 형식을 모두 처리할 수 있습니다.
-
상태 값을 모두 확인: 항상 HTTP 응답 상태 코드와 향상된 오류 코드 "상태" 필드를 모두 확인합니다. 둘 다 중요한 정보를 제공하므로 서로 다를 수 있습니다.
-
다시 시도 논리: 다시 시도해야 하는 오류의 경우 다시 시도가 제한되어 있는지(예: 2-3) 또는 서버를 압도하지 않도록 지수 백오프를 통해 수행되는지 확인하십시오. 또한 여러 항목을 한 번에 처리하는 Adobe Pass 인증 API(예: 사전 인증 API)의 경우, 전체 목록이 아니라 "다시 시도"로 표시된 항목만 반복된 요청에 포함해야 합니다.
-
구성 변경: 구성을 변경해야 하는 오류의 경우 새 응용 프로그램이나 새 기능을 시작하기 전에 필요한 변경이 수행되었는지 확인하십시오.
-
인증 및 권한 부여: 인증 및 권한 부여와 관련된 오류의 경우 사용자에게 다시 인증하거나 필요에 따라 새 권한을 부여하도록 요청해야 합니다.
-
사용자 피드백: 사용자가 읽을 수 있는 "메시지" 및 (잠재적인) "세부 정보" 필드를 사용하여 사용자에게 문제에 대해 알립니다(선택 사항). "세부 정보" 텍스트 메시지는 MVPD 사전 인증 또는 권한 부여 종단점 또는 성능 저하 규칙을 적용할 때 프로그래머로부터 전달될 수 있습니다.