개발자 콘솔 및 Postman 설정

이 단원에서는 Adobe 개발자 콘솔에서 프로젝트를 설정하고 Postman 컬렉션을 다운로드하여 Platform API 사용을 시작합니다.

이 자습서에서 API 연습을 완료하려면 운영 체제용 Postman 앱을 다운로드하십시오. Experience Platform API를 사용하기 위해 필요하지 않지만 Postman을 사용하면 API 워크플로우를 보다 쉽게 만들 수 있고 Adobe Experience Platform에서는 API 호출을 실행하고 작동 방법을 학습하는 데 도움이 되는 수십 개의 Postman 컬렉션을 제공합니다. 이 자습서의 나머지 부분에서는 Postman에 대한 작업 지식을 가정합니다. 도움이 필요하면 Postman 설명서를 참조하십시오.

플랫폼이 API부터 빌드됩니다. 모든 주요 작업에 대한 인터페이스 옵션도 있지만 어느 시점에서 플랫폼 API를 사용할 수 있습니다. 예를 들어, 데이터를 수집하거나, 샌드박스 간에 항목을 이동하거나, 일상적인 작업을 자동화하거나, UI가 구축되기 전에 새로운 플랫폼 기능을 사용할 수 있습니다.

데이터 아키텍처 및 데이터 엔지니어는 이 자습서 외부에서 플랫폼 API를 사용해야 할 수 있습니다.

필요한 권한

권한 구성 단원에서는 이 단원을 완료하는 데 필요한 모든 액세스 컨트롤을 설정합니다. 특히

  • 권한 항목 샌드박스 > Luma Tutorial
  • Luma Tutorial Platform 제품 프로필에 대한 개발자 역할 액세스

Adobe 개발자 콘솔 설정

  1. 자습서에서 사용되는 파일에 대해 이름이 Luma Tutorial Assets인 폴더를 로컬 컴퓨터에 만듭니다.

  2. Adobe 개발자 콘솔을 엽니다.

  3. 로그인한 다음 올바른 조직에 있는지 확인하십시오

  4. 빠른 시작 메뉴에서 새 프로젝트 만들기​를 선택합니다.

    새 프로젝트 만들기

  5. 새로 만든 프로젝트에서 Add to Project 단추를 선택한 다음 API 를 선택합니다

    Adobe 개발자 콘솔 프로젝트 API 구성

  6. Adobe Experience Platform​을 선택하여 목록을 필터링합니다.

  7. 사용 가능한 API 목록에서 Experience Platform API​를 선택하고 다음​을 선택합니다.

    Adobe 개발자 콘솔 프로젝트 API 구성

  8. Postman과 같은 외부 시스템에서 인증하려면 공개/개인 키 쌍이 필요합니다. 새 키 쌍을 생성하려면 옵션 1​을 선택하고 키 쌍 생성 단추를 누릅니다

    Adobe 개발자 콘솔 프로젝트 API 구성

  9. 키가 준비되면 로컬 컴퓨터에 키를 다운로드하라는 메시지가 표시될 수 있습니다. config.zip에 패키지된 키를 Luma Tutorial Assets 폴더에 저장합니다. 다음 연습에서는 필요하실 거예요

  10. 키가 생성되면 스크린샷에 표시된 대로 공개 키가 프로젝트에 자동으로 추가됩니다. 다음 단추를 선택합니다.

     키가 생성 및 선택된 후 보기

  11. Luma Tutorial Platform 제품 프로필을 선택하고 구성된 API 저장 단추를 선택합니다

    제품 프로필 선택

  12. 이제 개발자 콘솔 프로젝트가 생성되었습니다!

  13. 페이지의 Try out 섹션에서 Download for Postman​을 선택한 다음 서비스 계정(JWT)​을 선택하여 Postman 환경 json 파일을 다운로드합니다. Luma Tutorial Assets 폴더에 service.postman_environment.json을 저장합니다.

    Adobe 개발자 콘솔 프로젝트 API 구성

    노트

    조직의 시스템 관리자는 Admin Console의 제품 프로필에서 프로젝트를 "통합"으로 볼 수 있습니다

    Adobe 개발자 콘솔 프로젝트 API 구성

프로젝트에 번호가 할당되었음을 알 수 있습니다(예: "프로젝트 12").

  1. 이동 경로에서 프로젝트 번호를 선택합니다

  2. 프로젝트 편집 단추를 선택합니다.

  3. 프로젝트 제목​을 Luma Tutorial API Project(회사의 여러 사람이 이 자습서를 작성하고 있는 경우 이름을 끝에 추가)로 변경합니다.

  4. 저장 단추를 선택합니다.

    Adobe 개발자 콘솔 프로젝트 API 구성

Postman 설정

  1. Postman 다운로드 및 설치

  2. Postman 을 열고 다운로드한 json 환경 파일 service.postman_environment.json 을 가져옵니다.
    Adobe 개발자 콘솔 가져오기 환경

  3. Postman의 오른쪽 상단 드롭다운에서 환경을 선택하고 eye 아이콘을 선택하여 환경 변수를 확인합니다. ACCESS_TOKEN, PRIVATE_KEY 및 JWT_TOKEN 변수가 비어 있는 것을 볼 수 있습니다.

    Adobe 개발자 콘솔 프로젝트 API 구성

환경 이름 업데이트

개발자 콘솔에서 내보낸 환경 이름은 임의로 생성되므로 실제 플랫폼 구현 작업을 시작할 때 나중에 환경을 혼동하지 않도록 좀 더 설명적인 이름을 지정합니다.

  1. 환경 변수 화면이 여전히 열려 있는 상태에서 오른쪽 상단에서 편집​을 선택합니다

  2. 환경 이름​을 Luma Tutorial (으)로 업데이트

  3. 다음 단계에서 더 편집하게 되므로 환경 관리 모달을 편집 모드로 열어 둡니다

    Postman 환경 이름 업데이트

개인 키 추가

이제 Postman 환경에 PRIVATE_KEY 값을 추가할 차례입니다

  1. 개발자 콘솔 프로젝트를 생성하는 동안 이전 연습에서 생성된 다운로드한 config.zip 파일을 추출합니다. 이 zip에는 다음 두 파일이 포함되어 있습니다.
    • private.key
    • certificate_pub.crt
  2. 텍스트 편집기에서 private.key 파일을 열고 사용 가능한 모든 컨텐츠를 복사합니다.
  3. Postman의 환경 관리 > 편집 모달에서 마지막 연습에서 열려 있는 값을 초기 값현재 값 열의 PRIVATE_KEY 앞에 붙여 넣습니다.
  4. 업데이트 단추를 선택하여 PRIVATE_KEY와 업데이트된 환경 이름을 저장합니다.
    Postman에 붙여넣은 개인 키

JWT 및 액세스 토큰 추가

Adobe은 Experience Platform의 API를 탐색하는 데 도움이 되는 풍부한 Postman 컬렉션 세트를 제공합니다. 이러한 컬렉션은 Adobe Experience Platform Postman Samples GitHub 리포지토리에 있습니다. 이 자습서에서 여러 번 사용하고 나중에 회사를 위한 Experience Platform을 구현할 때 이 보고서를 책갈피로 지정해야 합니다.

첫 번째 컬렉션은 IMS(Adobe Identity Management Service) API에서 작동합니다. 샌드박스에서 이 자습서를 완료하는 등 비프로덕션 사용 사례​에 사용하기 위한 Postman​에서 JWT_TOKEN 및 ACCESS_TOKEN을 채우는 편리한 방법입니다. 또는 Adobe 개발자 콘솔 내에서 JWT 토큰을 생성할 수 있습니다. 그러나 이 컬렉션이 정기적으로 만료되므로 이 자습서를 완료하는 동안 Adobe 개발자 콘솔을 다시 방문하지 않고도 이 컬렉션을 새로 고칠 수 있습니다.

경고

Adobe I/O 액세스 토큰 생성 Postman 컬렉션 README에 설명된 대로, 설명되는 생성 방법은 비프로덕션 사용에 적합합니다. 로컬 서명은 타사 호스트에서 JavaScript 라이브러리를 로드하고 원격 서명은 개인 키를 소유 및 운영되는 웹 서비스로 보냅니다. Adobe은 이 개인 키를 저장하지 않지만 프로덕션 키는 다른 사람과 공유해서는 안 됩니다.

토큰을 생성하려면:

  1. 개발자 콘솔 액세스 토큰 생성 컬렉션Luma Tutorial Assets 폴더에 다운로드합니다

  2. 컬렉션을 Postman에 가져오기

  3. 요청 IMS 를 선택합니다.사용자 토큰​을 통해 JWT 생성 + 인증 을 선택하고 전송​을 선택합니다.

    토큰 요청

  4. JWT_TOKENACCESS_TOKEN 은 Postman의 환경 변수에 자동으로 채워집니다.

    포스트맨

샌드박스 이름 및 테넌트 ID 추가

SANDBOX_NAMETENANT_IDCONTAINER_ID 변수는 Adobe 개발자 콘솔에서 환경 내보내기에 제공되지 않으므로 수동으로 추가합니다.

  1. Postman에서 환경 변수 모달을 엽니다.

  2. 환경 이름의 오른쪽에 있는 편집 링크를 선택합니다

  3. 새 변수 추가 필드​에 SANDBOX_NAME를 입력합니다

  4. 두 값 필드에 이전 단원에서 샌드박스에 지정한 이름을 luma-tutorial 입력합니다. 샌드박스의 다른 이름(예: luma-tutorial-ignatisjreilly)을 사용한 경우 해당 값을 사용해야 합니다.

  5. 새 변수 추가 필드​에 TENANT_ID를 입력합니다

  6. 웹 브라우저로 전환하고 Experience Platform 인터페이스로 이동하고 @ sign 뒤에 URL​의 일부를 추출하여 회사의 테넌트 ID를 찾습니다. 예를 들어, 내 테넌트 ID는 techmarketingdemos이지만 사용자의 테넌트 ID는 다릅니다.

    플랫폼 인터페이스 URL에서 테넌트 ID 가져오기

  7. 이 값을 복사하고 Postman 환경 관리 화면으로 돌아갑니다.

  8. 테넌트 ID를 두 값 필드에 모두 붙여넣기

  9. 새 변수 추가 필드​에 CONTAINER_ID를 입력합니다

  10. 두 값 필드에 global을 입력합니다

    노트

    CONTAINER_ID 는 자습서 중에 값이 여러 번 변경되는 필드입니다. global을 사용하면 API가 Platform 계정의 Adobe 제공 요소와 상호 작용합니다. tenant 을 사용하면 API가 고유한 사용자 지정 요소와 상호 작용합니다.

  11. 업데이트 단추를 선택하여 변수를 저장합니다

    SANDBOX_NAME, TENANT_ID 및 CONTAINER_ID 필드가 환경 변수로 추가되었습니다.

이제 환경 관리 모달을 닫을 수 있습니다.

플랫폼 API 호출 만들기

이제 API 호출을 수행하여 모든 것을 올바르게 구성했는지 확인하겠습니다.

GitHub에서 다른 Experience Platform Postman 컬렉션 그룹, experience-platform-postman-samples을 엽니다. 이 페이지에는 다양한 Platform 기능과 관련된 컬렉션이 많이 있습니다.

이 자습서에서 필요에 따라 컬렉션을 다운로드합니다. 이 GitHub 리포지토리는 회사를 위한 Platform을 구현할 때 이 자습서 이후에 유용할 수 있으므로 책갈피를 지정하는 것이 좋습니다.

이제 첫 번째 API 호출을 수행해 보겠습니다.

  1. 스키마 레지스트리 API 컬렉션Luma Tutorial Assets 폴더에 다운로드합니다
  2. Postman에 가져옵니다.
  3. 스키마 레지스트리 API > 클래스 > 지정된 컨테이너에 있는 모든 클래스 나열
  4. ParamsHeaders 탭을 확인하고 이전에 입력한 환경 변수 중 일부를 포함하는 방법을 확인합니다.
  5. Headers > Accept value 필드​를 선택하고 application/vnd.adobe.xed-id+json로 변경합니다. 스키마 레지스트리 API에는 응답에서 다른 형식을 제공하는 지정된 Accept 헤더 값 중 하나가 필요합니다.
  6. 첫 번째 플랫폼 API를 호출하려면 Send 를 선택하십시오.

아래 그림과 같이 샌드박스에서 사용 가능한 표준 XDM 클래스 목록이 포함된 성공적인 200 OK 응답을 받았으면 합니다.

Postman의 첫 번째 API 호출

호출이 실패하면 API 호출의 오류 응답 세부 사항을 사용하여 디버깅하고 위의 단계를 검토하십시오. 문제가 발생하면 커뮤니티 포럼에서 도움말을 요청하거나 이 페이지의 오른쪽에 있는 링크를 사용하여 "문제 기록"하십시오.

추가 리소스

플랫폼 권한, 샌드박스 및 Postman이 설정되면 스키마에서 데이터를 모델링할 준비가 되었습니다!

이 페이지에서는