Adobe Experience Platform API 시작하기

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

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

인증 및 헤더

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

샌드박스 헤더

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

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

Content-type 헤더

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

Experience Platform API 기본 사항

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

JSON 스키마 개체 등 Platform이 활용하는 기본 API 기술에 대한 자세한 내용은 Experience Platform API 기본 사항 안내서를 참조하십시오.

Experience Platform API용 Postman 컬렉션

Postman은 사전 설정된 변수로 환경을 설정하고, API 컬렉션을 공유하고, CRUD 요청을 간소화하는 등 다양한 작업을 수행할 수 있는 API 개발을 위한 협업 플랫폼입니다. 대부분의 Platform API 서비스에는 API 호출을 지원하는 데 사용할 수 있는 Postman 컬렉션이 있습니다.

환경 설정 방법, 사용 가능한 컬렉션 목록, 컬렉션을 가져오는 방법 등 Postman에 대해 자세히 알아보려면 Platform Postman 설명서를 참조하세요.

샘플 API 호출 읽기 sample-api

요청 형식은 사용 중인 Platform API에 따라 다릅니다. API 호출을 구성하는 방법을 알아보는 가장 좋은 방법은 사용 중인 특정 플랫폼 서비스에 대한 설명서에 제공된 예제를 따르는 것입니다.

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

그런 다음 호출은 Request ​에서 cURL 명령으로 표시되며, 여기에는 API와 성공적으로 상호 작용하는 데 필요한 헤더와 전체 "기본 경로"가 포함됩니다. 기본 경로는 모든 끝점에 미리 첨부되어야 합니다. 예를 들어, 앞서 언급한 /global/classes 끝점은 https://platform.adobe.io/data/foundation/schemaregistry/global/classes이(가) 됩니다. 설명서 전체에서 API 형식/요청 패턴이 표시되며, Platform 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: {ORG_ID}' \
  -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 서비스를 사용할 때 발생할 수 있는 오류 목록을 제공합니다.

개별 플랫폼 서비스에 대한 문제 해결 안내서는 서비스 문제 해결 디렉터리를 참조하십시오.

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

Platform API 안내서 api-guides

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

다음 단계

이 문서에서는 필수 헤더와 사용 가능한 안내서를 소개하고 예제 API 호출을 제공했습니다. 이제 Adobe Experience Platform에서 API를 호출하는 데 필요한 헤더 값이 있으므로 Platform API 안내서 테이블에서 탐색하려는 API 끝점을 선택하십시오.

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

Postman 환경을 설정하고 사용 가능한 Postman 컬렉션을 살펴보려면 Platform Postman 안내서를 참조하세요.