Identity Service API 안내서

Adobe Experience Platform Identity Service은(는) Adobe Experience Platform 내에서 id 그래프라고 하는 것에서 고객을 교차 장치, 교차 채널 및 거의 실시간 식별하도록 관리합니다.

시작하기

이 안내서에서는 Adobe Experience Platform의 다음 구성 요소를 이해하고 있어야 합니다.

  • Identity Service: 고객 프로필 데이터 조각화에 의해 발생하는 근본적인 문제를 해결합니다. 고객이 브랜드와 상호 작용하는 장치 및 시스템에서 ID를 브리징하여 이를 수행합니다.
  • Real-time Customer Profile: 여러 소스에서 집계된 데이터를 기반으로 통합된 소비자 프로필을 실시간으로 제공합니다.
  • Experience Data Model (XDM): 고객 경험 데이터를 Platform 구성하는 표준화된 프레임워크입니다.

다음 섹션에서는 Identity Service API를 성공적으로 호출하기 위해 알고 있거나 현재 상태여야 하는 추가 정보를 제공합니다.

샘플 API 호출 읽기

이 안내서에서는 요청의 형식을 지정하는 방법을 보여주는 예제 API 호출을 제공합니다. 여기에는 경로, 필수 헤더 및 올바른 형식의 요청 페이로드가 포함됩니다. API 응답으로 반환되는 샘플 JSON도 제공됩니다. 샘플 API 호출에 대한 설명서에 사용된 규칙에 대한 자세한 내용은 Experience Platform 문제 해결 안내서에서 예제 API 호출를 읽는 방법 섹션을 참조하십시오.

필수 헤더에 대한 값을 수집합니다

Platform API를 호출하려면 먼저 인증 자습서를 완료해야 합니다. 인증 자습서를 완료하면 아래와 같이 모든 Experience Platform API 호출에 필요한 각 헤더에 대한 값을 제공합니다.

  • 권한 부여: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform의 모든 리소스는 특정 가상 샌드박스로 구분됩니다. Platform API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 헤더가 필요합니다.

  • x-sandbox-name: {SANDBOX_NAME}
노트

Platform의 샌드박스에 대한 자세한 내용은 샌드박스 개요 설명서를 참조하십시오.

페이로드(POST, PUT, PATCH)이 포함된 모든 요청에는 추가 헤더가 필요합니다.

  • 컨텐츠 유형: application/json

지역 기반 라우팅

Identity Service API는 요청 경로의 일부로 {REGION}을(를) 포함해야 하는 지역별 끝점을 사용합니다. IMS 조직을 프로비저닝하는 동안 영역은 IMS 조직 프로필 내에서 결정 및 저장됩니다. 각 종단점에 올바른 영역을 사용하면 Identity Service API를 사용하여 수행한 모든 요청이 해당 영역으로 라우팅됩니다.

현재 Identity Service API에서 지원하는 두 개의 영역이 있습니다. VA7와 NLD2입니다.

아래 표는 지역을 사용하는 경로의 예를 보여줍니다.

서비스 지역: VA7 지역: NLD2
Identity Service API https://platform-va7.adobe.io/data/core/identity/ https://platform-nld2.adobe.io/data/core/identity/
Identity Namespace API https://platform-va7.adobe.io/data/core/idnamespace/ https://platform-nld2.adobe.io/data/core/idnamespace
노트

지역을 지정하지 않고 요청을 수행하면 잘못된 지역으로 라우팅이 전송되거나 호출이 예기치 않게 실패할 수 있습니다.

IMS 조직 프로필 내에서 해당 지역을 찾을 수 없는 경우 시스템 관리자에게 문의하여 지원을 받으십시오.

Identity Service API 사용

이러한 서비스에 사용되는 ID 매개 변수는 두 가지 방법 중 하나로 표시할 수 있습니다. XID 또는 XID를 조합합니다.

복합 ID는 ID 값과 네임스페이스를 모두 포함하는 구문입니다. 복합 ID를 사용할 때 이름(namespace.code) 또는 ID(namespace.id)로 네임스페이스를 제공할 수 있습니다.

ID가 유지되면 Identity Service 은 네이티브 ID 또는 XID라고 하는 ID를 생성하여 해당 ID에 할당합니다. 클러스터 및 매핑 API의 모든 변형은 해당 요청과 응답에서 복합 ID와 XID를 모두 지원합니다. 매개 변수 중 하나는 이러한 API를 사용하려면 xid 또는 [ns 또는 nsid] 와 id의 조합이 필요합니다.

응답에서 페이로드를 제한하기 위해 API는 사용된 ID 구성 유형에 대한 응답을 조정합니다. 즉, XID를 전달하는 경우 응답에 XID가 있고 복합 ID를 전달하는 경우 응답에는 요청에 사용된 구조를 따릅니다.

이 문서의 예제는 Identity Service API의 전체 기능을 다루지 않습니다. 전체 API에 대해서는 Swagger API 참조를 참조하십시오.

노트

요청에서 네이티브 XID를 사용하는 경우 반환되는 모든 ID는 기본 XID 양식에 표시됩니다. ID/네임스페이스 양식을 사용하는 것이 좋습니다. 자세한 내용은 ID에 대한 XID 가져오기의 섹션을 참조하십시오.

다음 단계

이제 필요한 자격 증명을 수집했으므로 개발자 가이드의 나머지 부분을 계속 읽을 수 있습니다. 각 섹션에서는 종단점에 대한 중요한 정보를 제공하며 CRUD 작업을 수행하기 위한 예제 API 호출을 보여줍니다. 각 호출에는 일반 API 형식, 필수 헤더와 올바른 형식의 페이로드를 보여주는 샘플 요청 및 성공적인 호출을 위한 샘플 응답이 포함되어 있습니다.

이 페이지에서는