Experience Platform API 인증 및 액세스

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

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

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

전제 조건 prerequisites

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

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

Experience Platform을 위한 개발자 및 사용자 액세스 권한 획득 gain-developer-user-access

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

개발자 액세스 권한 얻기 gain-developer-access

Admin Console을(를) 사용하여 Experience Platform 제품 프로필에 개발자로 추가하려면 조직의 Admin Console 관리자에게 문의하십시오. 제품 프로필에 대한 개발자 액세스를 관리하는 방법에 대한 특정 지침은 Admin Console 설명서를 참조하세요.

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

사용자 액세스 권한 얻기 gain-user-access

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

자세한 내용은 에서 사용자 그룹 관리 Admin Console에 대한 안내서를 참조하십시오.

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

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

프로젝트에 Experience Platform 추가 add-platform-to-project

Adobe Developer Console(으)로 이동하여 Adobe ID으로 로그인합니다. 그런 다음 Adobe Developer Console 설명서에서 빈 프로젝트 만들기에 대한 자습서에 설명된 단계를 수행합니다.

새 프로젝트를 만든 후에는 프로젝트 개요 화면에서 API 추가 ​를 선택합니다.

API 추가 옵션이 강조 표시된

API 추가 화면이 나타납니다. Adobe Experience Platform의 제품 아이콘을 선택한 후 다음 ​을 선택하기 전에 Experience Platform API ​를 선택하십시오.

OAuth 서버 간 인증 유형 선택 select-oauth-server-to-server

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

통합할 제품 프로필 선택 select-product-profiles

API 구성 화면에서 AEP-Default-All-Users ​를 선택합니다.

준비가 되면 구성된 API 저장 ​을(를) 선택하십시오.

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

자격 증명 수집 gather-credentials

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

액세스 토큰 생성 generate-access-token

다음 단계는 Platform API 호출에 사용할 {ACCESS_TOKEN} 자격 증명을 생성하는 것입니다. {API_KEY} 및 {ORG_ID}의 값과 달리 Platform API를 계속 사용하려면 24시간마다 새 토큰을 생성해야 합니다. 아래와 같이 액세스 토큰 생성 ​을 선택하십시오.

API 참조 설명서에서 직접 인증 자격 증명을 만들고 검색합니다. get-credentials-functionality

2024년 11월 Experience Platform 릴리스부터 Developer Console (으)로 이동할 필요 없이 API 참조 페이지에서 직접 Experience Platform API를 사용하기 위한 자격 증명을 가져올 수 있습니다. 흐름 서비스 API - 대상 페이지에서 아래 예제를 보십시오.

Platform API를 호출하기 위한 자격 증명을 가져오려면 Experience Platform API 참조 페이지로 이동한 다음 페이지 맨 위에서 로그인 ​을 선택합니다. 개인 계정 또는 회사 또는 학교 계정 ​으로 로그인하세요.

로그인 후 새 자격 증명 만들기 ​를 선택하여 Platform API에 액세스할 수 있는 새 자격 증명 집합을 만듭니다.

그런 다음 드롭다운 선택기를 사용하여 자격 증명 창을 열고, 액세스 토큰을 생성하고, API 키 및 조직 ID를 가져옵니다. Platform API 작업을 시작하려면 API 참조 페이지의 시도 블록에 자격 증명을 복사하세요.

[사용되지 않음]{class="badge negative"} JSON 웹 토큰(JWT) 생성 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
}

액세스 자격 증명 테스트 test-credentials

액세스 토큰, 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"
    }
  ]
}

필요한 속성 기반 액세스 제어 권한 얻기 get-abac-permissions

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

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

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

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 권한 부여 grant-developer-and-api-access-control

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

제품 프로필에 개발자 추가 add-developers-to-product-profile

Admin Console(으)로 이동하여 Adobe ID으로 로그인합니다.

제품 ​을 선택한 다음 제품 목록에서 Adobe Experience Platform ​을 선택합니다.

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

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

개발자의 전자 메일 또는 사용자 이름 ​을(를) 입력하십시오. 유효한 전자 메일 또는 사용자 이름에 개발자 세부 정보가 표시됩니다. 저장 ​을 선택합니다.

개발자가 추가되었으며 개발자 탭에 나타납니다.

역할에 API 할당

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

권한 및 API를 추가할 역할을 선택하십시오. API 자격 증명 탭을 선택한 다음 API 자격 증명 추가 ​를 선택합니다.

선택한 역할의

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

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

새로 추가된 API가 있는

추가 리소스 additional-resources

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

다음 단계 next-steps

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

이 자습서에서 수집한 인증 값 외에도 많은 Platform API를 사용하려면 헤더로 올바른 {SANDBOX_NAME}을(를) 제공해야 합니다. 자세한 내용은 샌드박스 개요를 참조하십시오.