Experience Platform API 인증 및 액세스

이 문서에서는 Experience Platform API를 호출하기 위해 Adobe Experience Platform 개발자 계정에 액세스할 수 있는 단계별 자습서를 제공합니다. 이 자습서가 끝나면 모든 Platform API 호출에서 헤더로 필요한 다음 자격 증명을 생성하거나 수집하게 됩니다.

• {ACCESS_TOKEN}
• {API_KEY}
• {ORG_ID}

애플리케이션 및 사용자의 보안을 유지하려면 OAuth와 같은 표준을 사용하여 Experience Platform API에 대한 모든 요청을 인증 및 승인해야 합니다.

이 자습서에서는 아래 순서도에 설명된 대로 Platform API 호출을 인증하는 데 필요한 자격 증명을 수집하는 방법을 다룹니다. 초기 1회 설정에서 필요한 자격 증명 대부분을 수집할 수 있습니다. 그러나 액세스 토큰은 24시간마다 새로 고쳐야 합니다.

전제 조건

Experience Platform API를 성공적으로 호출하려면 다음 조건을 충족해야 합니다.

• Adobe Experience Platform에 액세스할 수 있는 조직입니다.
• 귀하를 제품 프로필의 개발자 및 사용자로 추가할 수 있는 Admin Console 관리자.
• API를 통해 Experience Platform의 여러 부분에서 읽기 또는 쓰기 작업을 수행하는 데 필요한 속성 기반 액세스 제어를 부여할 수 있는 Experience Platform 시스템 관리자.

또한 이 자습서를 완료하려면 Adobe ID이 있어야 합니다. Adobe ID이 없는 경우 다음 단계를 사용하여 만들 수 있습니다.

1. 다음으로 이동 Adobe Developer 콘솔.
2. 선택 새 계정 만들기.
3. 등록 프로세스를 완료합니다.

Experience Platform을 위한 개발자 및 사용자 액세스 권한 획득

Adobe Developer Console에서 통합을 만들기 전에 계정에 Adobe Admin Console의 Experience Platform 제품 프로필에 대한 개발자 및 사용자 권한이 있어야 합니다.

개발자 액세스 권한 얻기

다음 연락처로 이동 Admin Console 를 사용하여 귀하를 Experience Platform 제품 프로필에 개발자로 추가할 조직의 관리자 Admin Console. 다음을 참조하십시오. Admin Console 다음 방법에 대한 특정 지침 설명서 제품 프로필에 대한 개발자 액세스 관리.

개발자로 할당되면에서 통합 만들기를 시작할 수 있습니다. Adobe Developer 콘솔. 이러한 통합은 외부 앱 및 서비스에서 Adobe API로의 파이프라인입니다.

사용자 액세스 권한 얻기

사용자 Admin Console 관리자가 귀하를 동일한 제품 프로필에 사용자로 추가해야 합니다. 사용자 액세스를 사용하면 UI에서 사용자가 수행하는 API 작업의 결과를 볼 수 있습니다.

다음 안내서를 참조하십시오 에서 사용자 그룹 관리 Admin Console 추가 정보.

API 키(클라이언트 ID) 및 조직 ID 생성

을 통해 개발자 및 사용자에게 플랫폼에 대한 액세스 권한이 부여되면 Admin Console, 다음 단계는 를 생성하는 것입니다. {ORG_ID} 및 {API_KEY} Adobe Developer 콘솔의 자격 증명입니다. 이러한 자격 증명은 한 번만 생성하면 되며 향후 Platform API 호출에서 재사용할 수 있습니다.

프로젝트에 Experience Platform 추가

다음으로 이동 Adobe Developer 콘솔 Adobe ID으로 로그인합니다. 다음은에 대한 자습서에 설명된 단계를 따릅니다. 빈 프로젝트 만들기 Adobe Developer 콘솔 설명서에서 확인할 수 있습니다.

새 프로젝트를 만들었으면 다음을 선택합니다. API 추가 다음에 있음 프로젝트 개요 화면.

다음 API 추가 화면이 나타납니다. Adobe Experience Platform에 대한 제품 아이콘을 선택한 다음 을 선택합니다. EXPERIENCE PLATFORM API 선택하기 전 다음.

OAuth 서버 간 인증 유형 선택

그런 다음 인증 유형을 선택하여 액세스 토큰을 생성하고 Experience Platform API에 액세스합니다.

통합할 제품 프로필 선택

다음에서 API 구성 화면, 선택 AEP-Default-All-Users.

선택 구성된 API 저장 준비가 되면.

위에서 설명한 Experience Platform API와의 통합 설정 단계에 대한 연습은 아래 비디오 튜토리얼에서도 사용할 수 있습니다.

자격 증명 수집

API가 프로젝트에 추가되면 EXPERIENCE PLATFORM API 프로젝트 페이지에는 모든 Experience Platform API 호출에 필요한 다음 자격 증명이 표시됩니다.

• {API_KEY} (클라이언트 ID)
• {ORG_ID} (조직 ID)

액세스 토큰 생성

다음 단계는 를 생성하는 것입니다. {ACCESS_TOKEN} platform API 호출에 사용할 자격 증명입니다. 의 값과 다르게 {API_KEY} 및 {ORG_ID}Platform API를 계속 사용하려면 24시간마다 새 토큰을 생성해야 합니다. 선택 액세스 토큰 생성​아래에 표시된 대로 를 클릭합니다.

더 이상 사용되지 않음 JSON 웹 토큰(JWT) 생성

curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

액세스 자격 증명 테스트

액세스 토큰, API 키 및 조직 ID 의 세 가지 필수 자격 증명을 모두 수집하면 다음 API 호출을 시도할 수 있습니다. 이 호출은 모든 표준을 나열합니다. Experience Data Model 조직에서 사용할 수 있는 (XDM) 클래스. 에서 호출을 가져오고 실행합니다. Postman.

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}}'

{
  "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"
    }
  ]
}

필요한 속성 기반 액세스 제어 권한 얻기

Experience Platform 내에서 여러 리소스에 액세스하거나 수정하려면 적절한 액세스 제어 권한이 있어야 합니다. 시스템 관리자는 다음 권한을 부여할 수 있습니다. 필요한 권한. 다음에 대한 섹션에서 자세한 정보 가져오기 역할에 대한 API 자격 증명 관리.

시스템 관리자가 API를 통해 Platform 리소스에 액세스하는 데 필요한 권한을 부여하는 방법에 대한 자세한 내용은 아래 비디오 튜토리얼에서도 확인할 수 있습니다.

Postman을 사용하여 API 호출 인증 및 테스트

Postman 는 개발자가 RESTful API를 탐색하고 테스트할 수 있도록 하는 인기 있는 도구입니다. Experience Platform Postman 컬렉션 및 환경을 사용하여 Experience Platform API를 통한 작업 속도를 높일 수 있습니다. 자세한 내용 Experience Platform에서 Postman 사용 컬렉션 및 환경 시작하기

Experience Platform 컬렉션 및 환경과 함께 Postman 사용에 대한 자세한 내용은 아래 비디오 튜토리얼에서도 확인할 수 있습니다.

Experience Platform API와 함께 사용할 Postman 환경 다운로드 및 가져오기

Postman 컬렉션을 사용하여 액세스 토큰 생성

다운로드 Identity Management 서비스 Postman 컬렉션 또한 아래 비디오를 시청하여 액세스 토큰을 생성하는 방법을 살펴보십시오.

Experience Platform API Postman 컬렉션 다운로드 및 API와 상호 작용

시스템 관리자: 개발자 및 API 액세스 제어에 Experience Platform 권한 부여

Adobe Developer Console에서 통합을 만들기 전에 계정에 Adobe Admin Console의 Experience Platform 제품 프로필에 대한 개발자 및 사용자 권한이 있어야 합니다.

제품 프로필에 개발자 추가

Admin Console으로 이동한 뒤 Adobe ID로 로그인합니다.

선택 제품​을 선택한 다음 을 선택합니다. Adobe Experience Platform 을 클릭합니다.

다음에서 제품 프로필 탭, 선택 AEP-Default-All-Users. 또는 검색 창을 사용하여 이름을 입력하여 제품 프로필을 검색합니다.

다음 항목 선택 개발자 탭을 선택한 다음 를 선택합니다 개발자 추가.

개발자 입력 이메일 또는 사용자 이름. 유효 이메일 또는 사용자 이름 개발자 세부 사항이 표시됩니다. 저장​을 선택합니다.

개발자가 추가되고에 표시됩니다. 개발자 탭.

역할에 API 할당

시스템 관리자는 Experience Platform UI의 역할에 API를 할당할 수 있습니다.

선택 권한 API를 추가할 역할입니다. 다음 항목 선택 API 자격 증명 탭을 선택한 다음 를 선택합니다 API 자격 증명 추가.

역할에 추가할 API를 선택한 다음 를 선택합니다 저장.

(으)로 돌아갑니다. API 자격 증명 새로 추가된 API가 나열된 탭입니다.

추가 리소스

Experience Platform API를 시작하는 데 도움이 필요하면 아래 연결된 추가 리소스를 참조하십시오

• Experience Platform API 인증 및 액세스 비디오 튜토리얼 페이지
• Identity Management 서비스 Postman 컬렉션 액세스 토큰 생성용
• Experience Platform API Postman 컬렉션

다음 단계

이 문서를 읽고 Platform API에 대한 액세스 자격 증명을 수집하고 성공적으로 테스트했습니다. 이제 를 통해 제공되는 예제 API 호출과 함께 따를 수 있습니다. 설명서.

이 자습서에서 수집한 인증 값 외에도 많은 Platform API에 유효한 값이 필요합니다 {SANDBOX_NAME} 헤더로 제공될 예정입니다. 자세한 내용은 샌드박스 개요를 참조하십시오.