Platform FAQ 및 문제 해결 안내서

이 문서에서는 Adobe Experience Platform에 대해 자주 묻는 질문에 대한 답변과 Experience Platform API에서 발생할 수 있는 일반적인 오류에 대한 개요 문제 해결 안내서를 제공합니다. 개별 Platform 서비스에 대한 문제 해결 가이드는 아래의 서비스 문제 해결 디렉토리를 참조하십시오.

FAQ

다음은 Adobe Experience Platform에 대해 자주 묻는 질문에 대한 답변 목록입니다.

Experience Platform API란 무엇입니까?

Experience Platform 에서는 리소스에 액세스하기 위해 HTTP 요청을 사용하는 여러 RESTful API를 Platform 제공합니다. 이러한 서비스 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 요청의 헤더로 필요합니다. 이 ID는 Adobe 개발자 콘솔을 통해 찾을 수 있습니다. 통합 탭에서 특정 통합에 대한 개요 섹션으로 이동하여 클라이언트 자격 증명​에서 ID를 찾습니다. Platform에 인증하는 방법에 대한 단계별 연습은 인증 자습서를 참조하십시오.

API 키는 어디에서 찾을 수 있습니까?

API 키는 모든 API 요청의 헤더로 필요합니다. Adobe 개발자 콘솔을 통해 찾을 수 있습니다. 콘솔 내의 통합 탭에서 특정 통합에 대한 개요 섹션으로 이동하면 클라이언트 자격 증명 아래에 키가 있습니다. 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 Pointer 문자열을 사용하여 업데이트할 JSON 속성을 나타냅니다. 이러한 매개 변수는 일반적으로 JSON 패치 형식을 사용하여 요청 페이로드에 포함됩니다. 이러한 기술에 필요한 구문에 대한 자세한 내용은 API Fundamentals 안내서를 참조하십시오.

Postman을 사용하여 Platform API를 호출할 수 있습니까?

🔗 Postman은 RESTful API에 대한 호출을 시각화하는 데 유용한 도구입니다. Platform API 시작 안내서에는 Postman 컬렉션을 가져오기 위한 비디오 및 지침이 포함되어 있습니다. 또한, 각 서비스의 Postman 컬렉션 목록이 제공됩니다.

Platform에 대한 시스템 요구 사항은 무엇입니까?

UI를 사용하는지 또는 API를 사용하는지에 따라 다음 시스템 요구 사항이 적용됩니다.

UI 기반 작업의 경우:

  • 최신 표준 웹 브라우저입니다. 최신 버전의 Chrome이 권장되지만, Firefox, Internet Explorer 및 Safari의 현재 및 이전 주요 릴리스도 지원됩니다.
    • 새 주요 버전이 릴리스될 때마다 Platform은(는) 최신 버전을 지원하는 반면, 가장 최근 세 번째 버전에 대한 지원은 삭제됩니다.
  • 모든 브라우저에는 쿠키와 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 호출을 수행할 때 이러한 헤더가 누락되었거나 잘못된 경우 다음 오류가 발생할 수 있습니다.

OAuth 토큰이 없습니다.

{
    "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인지 확인합니다.

사용자 영역이 없습니다.

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

이 오류 메시지는 계정(제공된 인증 자격 증명으로 표시됨)이 Experience Platform에 대한 제품 프로필과 연결되어 있지 않을 때 표시됩니다. 플랫폼 API 인증 자습서에서 액세스 자격 증명을 생성하는 단계에 따라 Platform을 계정에 추가하고 그에 따라 인증 자격 증명을 업데이트합니다.

서비스 문제 해결 디렉터리

다음은 Experience Platform API에 대한 문제 해결 가이드 및 API 참조 설명서 목록입니다. 각 문제 해결 안내서에서는 개별 Platform 서비스에만 해당되는 문제에 대한 FAQ 및 해결 방법을 제공합니다. 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 ID 서비스 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 FAQ 및 문제 해결 안내서
Flow Service (Sources 및 Destinations) Flow Service API
Real-time Customer Profile Real-time Customer Profile API Profile 문제 해결 안내서
샌드박스 샌드박스 API 샌드박스 문제 해결 안내서

이 페이지에서는