Adobe Experience Platform API 시작하기

Adobe Experience Platform은 "API first" 철학을 바탕으로 개발되었습니다. 플랫폼 API를 사용하면 계산된 속성 구성, 데이터/엔티티 액세스, 데이터 내보내기, 불필요한 데이터 또는 배치 삭제 등과 같은 데이터에 대해 기본 CRUD(만들기, 읽기, 업데이트, 삭제) 작업을 프로그래밍 방식으로 수행할 수 있습니다.

각 Experience Platform 서비스에 대한 API는 모두 동일한 인증 헤더 집합을 공유하고 CRUD 작업에 대해 유사한 구문을 사용합니다. 다음 안내서에서는 플랫폼 API를 시작하는 데 필요한 단계를 설명합니다.

인증 및 헤더

플랫폼 끝점을 성공적으로 호출하려면 인증 자습서를 완료해야 합니다. 인증 자습서를 완료하면 아래와 같이 Experience Platform API 호출에서 각 필수 헤더에 대한 값을 제공합니다.

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

샌드박스 헤더

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

  • x-sandbox-name: {SANDBOX_NAME}

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

컨텐츠 유형 헤더

요청 본문에 페이로드가 있는 모든 요청(POST, PUT 및 PATCH 호출 등)은 Content-Type 헤더를 포함해야 합니다. 허용된 값은 각 API 끝점에 따라 다릅니다. 끝점에 특정 Content-Type 값이 필요한 경우 해당 값은 개별 플랫폼 서비스🔗에 대한 API 안내서가 제공하는 예제 API 요청에 표시됩니다.

Experience Platform API 기본 사항

Adobe Experience Platform API는 플랫폼 리소스를 효과적으로 관리하기 위해 이해하기에 중요한 몇 가지 기본 기술 및 구문을 사용합니다.

예제 JSON 스키마 개체를 포함하여 API 플랫폼이 활용하는 기본 기술에 대해 자세히 알아보려면 Experience Platform API fundamentals 안내서를 참조하십시오.

Experience Platform API용 Postman 컬렉션

Postman은 사전 설정 변수가 있는 환경을 설정하고, API 컬렉션을 공유하고, CRUD 요청을 능률화하는 등 API 개발을 위한 공동 작업 플랫폼입니다. 대부분의 플랫폼 API 서비스에는 API 호출을 수행하는 데 도움이 되는 Postman 컬렉션이 있습니다.

환경 설정 방법, 사용 가능한 컬렉션 목록, 컬렉션 가져오기 방법 등 Postman에 대한 자세한 내용은 플랫폼 Postman 설명서를 참조하십시오.

샘플 API 호출 읽기

요청 형식은 사용 중인 플랫폼 API에 따라 달라집니다. API 호출을 구조화하는 방법을 학습하는 가장 좋은 방법은 사용 중인 특정 플랫폼 서비스에 대한 설명서에서 제공하는 예제와 함께 따르는 것입니다.

Experience Platform에 대한 설명서에는 두 가지 방법으로 API 호출 예를 보여줍니다. 먼저 호출은 API 형식​으로 표시되고 작업(GET, POST, PUT, PATCH, DELETE) 및 사용된 끝점(예: /global/classes)만 표시하는 템플릿 표현입니다. 일부 템플릿은 GET /{VARIABLE}/classes/{ANOTHER_VARIABLE} 등의 호출을 공식화하는 방법을 보여주는 데 도움이 되는 변수의 위치를 보여줍니다.

그런 다음 호출은 API와 성공적으로 상호 작용하는 데 필요한 헤더와 전체 "기본 경로"를 포함하는 요청​에 cURL 명령으로 표시됩니다. 기본 경로는 모든 끝점에 프리펜드되어야 합니다. 예를 들어 전술한 /global/classes 끝점은 https://platform.adobe.io/data/foundation/schemaregistry/global/classes이 됩니다. 설명서 전체에서 API 형식/요청 패턴을 볼 수 있으며 플랫폼 API를 직접 호출할 때 예제 요청에서 표시되는 전체 경로를 사용할 것으로 예상됩니다.

API 요청 예

다음은 설명서에서 보게 될 형식을 보여 주는 API 요청의 예입니다.

API 형식

API 형식은 사용 중인 작업(GET) 및 끝점을 표시합니다. 변수는 중괄호로 표시됩니다(이 경우 {CONTAINER_ID}).

GET /{CONTAINER_ID}/classes

요청

이 예제 요청에서 API 형식의 변수는 요청 경로에 실제 값이 주어집니다. 또한 모든 필수 헤더는 중요한 정보(보안 토큰 및 액세스 ID 등)가 포함되어야 하는 샘플 헤더 값 또는 변수로 표시됩니다.

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

응답은 전송된 요청을 기준으로 API에 대한 성공적인 호출 후 받게 될 응답을 보여줍니다. 경우에 따라 응답이 공간을 위해 잘리는 경우가 있습니다. 즉, 샘플에 표시되는 추가 정보 또는 정보를 볼 수 있습니다.

{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

오류 메시지

플랫폼 문제 해결 안내서에서는 Experience Platform 서비스를 사용할 때 발생할 수 있는 오류 목록을 제공합니다.

개별 플랫폼 서비스에 대한 문제 해결 가이드는 서비스 문제 해결 디렉토리를 참조하십시오.

필수 헤더 및 요청 본문을 포함하여 플랫폼 API의 특정 끝점에 대한 자세한 내용은 플랫폼 API 안내서를 참조하십시오.

플랫폼 API 안내서

API 안내서 설명
Access Control API 안내서 Access Control API 끝점은 지정된 샌드박스 내의 지정된 리소스에 대해 사용자의 현재 정책을 검색할 수 있습니다. 다른 모든 액세스 제어 기능은 Adobe Admin Console을 통해 제공됩니다.
일괄 처리 통합 API 안내서 Adobe Experience Platform Data Ingestion API를 사용하여 데이터를 플랫폼에 일괄 파일로 인제스트할 수 있습니다. 인제스트되는 데이터는 CRM 시스템의 플랫 파일(예: 쪽모이 세공 항목 파일)의 프로파일 데이터이거나 XDM(스키마 레지스트리)의 알려진 스키마를 따르는 데이터일 수 있습니다.
Catalog Service API 안내서 개발자는 Catalog Service API를 사용하여 Adobe Experience Platform의 데이터 세트 메타데이터를 관리할 수 있습니다. 여기에는 데이터 위치, 처리 단계, 처리 중 발생한 오류 및 데이터 보고서가 포함됩니다.
Data Access API 안내서 Data Access API를 사용하면 개발자는 Experience Platform 내에서 인제스트된 데이터 세트에 대한 정보를 검색할 수 있습니다. 데이터세트 파일에 액세스 및 다운로드, 헤더 정보 검색, 실패한 배치 및 성공한 배치 나열, 미리 보기 CSV/쪽모이 세공 항목 파일 다운로드가 포함됩니다.
Dataset Service API 안내서 데이터 집합 서비스 API를 사용하여 데이터 집합에 대한 사용 레이블을 적용하고 편집할 수 있습니다. 이것은 Adobe Experience Platform의 데이터 카탈로그 기능의 일부이지만 데이터 세트 메타데이터를 관리하는 카탈로그 서비스 API와는 별개입니다.
Flow Service API 안내서
(소스 및 대상)
Flow Service API는 다양한 소스의 데이터를 수집 및 중앙화하는 데 사용되며 Adobe Experience Platform 내의 다양한 대상에 데이터를 생성하고 활성화하는 데 사용됩니다. 이 서비스는 지원되는 모든 소스가 연결되어 있는 RESTful API를 제공합니다.
Identity Service API 안내서 개발자는 Identity Service API를 사용하여 Adobe Experience Platform에서 ID 그래프를 사용하여 디바이스 간, 크로스 채널 및 거의 실시간으로 고객 ID를 관리할 수 있습니다.
Observability Insights API 안내서 Observability Insights 는 개발자가 Adobe Experience Platform에서 주요 관찰 가능성 지표를 노출할 수 있도록 하는 RESTful API입니다. 이러한 지표는 플랫폼 사용 통계, 플랫폼 서비스에 대한 상태 점검, 이전 동향 및 다양한 플랫폼 기능에 대한 성능 지표에 대한 통찰력을 제공합니다.
Policy Service API 안내서
(데이터 거버넌스)
Policy Service API를 사용하면 데이터 사용 레이블 및 정책을 만들고 관리하여 특정 데이터 사용 레이블이 포함된 데이터에 대해 수행할 수 있는 마케팅 작업을 결정할 수 있습니다. 데이터 세트 및 필드에 레이블을 적용하려면 Dataset Service API 안내서를 참조하십시오.
Privacy Service API 안내서 개발자는 Privacy Service API를 사용하여 법적 개인 정보 보호 규정을 준수하여 Experience Cloud 응용 프로그램에서 고객 개인 데이터에 액세스하거나 삭제하도록 고객 요청을 작성하고 관리할 수 있습니다.
Query Service API 안내서 Query Service API를 사용하면 개발자는 표준 SQL을 사용하여 Adobe Experience Platform 데이터를 쿼리할 수 있습니다.
Real-time Customer Profile API 안내서 개발자는 실시간 고객 프로필 API를 사용하여 프로필 보기, 병합 정책 만들기 및 업데이트, 프로필 데이터 내보내기 또는 샘플링, 더 이상 필요하거나 오류가 추가된 프로필 데이터 삭제 등 프로필 데이터를 확인하고 작업할 수 있습니다.
샌드박스 API 안내서 Sandbox API를 사용하면 개발자는 Adobe Experience Platform에서 격리된 가상 샌드박스 환경을 프로그래밍 방식으로 관리할 수 있습니다.
Schema Registry API 안내서
(XDM)
개발자가 Schema Registry API를 사용하여 Adobe Experience Platform 내의 모든 스키마 및 관련 XDM(Experience Data Model) 리소스를 프로그래밍 방식으로 관리할 수 있습니다.
Segmentation Service API 안내서 개발자는 Segmentation Service API를 사용하여 Adobe Experience Platform의 세그멘테이션 작업을 프로그래밍 방식으로 관리할 수 있습니다. 세그먼트를 작성하고 실시간 고객 프로필 데이터에서 대상을 생성하는 작업이 포함됩니다.
Sensei Machine Learning API 안내서
(데이터 과학 작업 공간)
Sensei Machine Learning API는 데이터 과학자들이 알고리즘 온보딩, 실험 및 서비스 배포에 이르기까지 ML(Machine Learning) 서비스를 구성하고 관리하는 메커니즘을 제공합니다.

각 서비스에 사용할 수 있는 특정 끝점 및 작업에 대한 자세한 내용은 Adobe I/O의 API 참조 설명서를 참조하십시오.

다음 단계

이 문서에서는 필수 헤더, 사용 가능한 안내선을 소개하고 예제 API 호출을 제공합니다. 이제 Adobe Experience Platform에서 API 호출을 수행하는 데 필요한 필수 헤더 값이 있으므로 플랫폼 API 안내선 표에서 탐색할 API 끝점을 선택합니다.

FAQ에 대한 답변은 플랫폼 문제 해결 안내서를 참조하십시오.

Postman 환경을 설정하고 사용 가능한 Postman 컬렉션을 탐색하려면 Platform Postman 안내서를 참조하십시오.

이 페이지에서는