이 안내서에서는 데이터 추출, 사용자 정의 솔루션 및 타사 통합을 자세히 설명하는 Adobe Customer Journey Analytics(CJA) API를 다룹니다. 여기에는 액세스 설정, API 키, Postman을 통한 테스트, 단계별 API 호출 예시 및 초보자를 위한 팁이 포함되어 있습니다.
API를 처음 사용하시나요? Adobe Customer Journey Analytics(CJA) API가 어떻게 도움이 될 수 있는지 궁금하신가요? 겁내지 마세요! 이 초급자를 위한 안내서에서는 필수 사항을 안내하고, 전문 용어를 분석하며, CJA API의 흥미로운 세계로 첫 발을 내딛는 데 도움을 드립니다.
수동적인 노력 없이 CJA 데이터에 프로그래밍적으로 액세스하고 분석할 수 있는 능력을 갖는다고 상상해 보세요. 바로 그것이 CJA API를 통해 할 수 있는 일입니다!
- 효율적으로 데이터 추출: API 호출을 사용하여 데이터 추출을 간소화합니다.
- 사용자 정의 솔루션 빌드: 특정 비즈니스 요구에 맞게 자동화된 보고 파이프라인을 디자인하고 구현합니다.
- 원활한 연결: 강력한 통합을 통해 CJA와 타사 애플리케이션 간의 원활한 데이터 흐름을 사용할 수 있습니다.
API를 메신저라고 생각해 보세요. API는 사용자의 요청을 Adobe 서버로 전달하고 깔끔한 패키지로 결과를 가져옵니다.
성공을 위한 설정
첫 번째 API 호출을 하기 전에 적절한 액세스 및 권한을 설정해야 합니다. 먼저 조직의 개발자로 추가되어야 합니다. 그런 다음 필요한 권한이 있는 제품 프로필에 액세스할 수 있는지 확인하세요.
1단계: API 키 가져오기
- Adobe Developer Console에 로그인합니다.
- 새 프로젝트를 만들고 프로젝트에 Customer Journey Analytics API 를 추가한 후 필요한 제품 프로필을 선택합니다.
- 프로젝트에 추가 를 클릭하고 Adobe Experience Platform API 도 프로젝트에 추가합니다.
- 설치가 완료되면 왼쪽의 자격 증명 탭에서 필요한 모든 정보를 가져올 수 있습니다.
모든 API 요청에 필요한 세 가지 필수 헤더 매개변수는 다음과 같습니다.
- 액세스 토큰 - 이렇게 하면 권한이 있는 사용자만 데이터에 액세스할 수 있으며, 스크린샷에 강조 표시된 액세스 토큰 생성 CTA를 클릭하여 생성할 수 있습니다. AP 요청의 인증 매개변수라고 합니다.
- 클라이언트 ID - API 키라고도 하며, API 요청에서 x-api-key 입니다.
- 조직 ID - API 요청에서 x-gw-ims-org-id 입니다.
이러한 자격 증명을 저장해야 합니다. API의 기능을 잠금 해제하는 데 필요한 핵심 요소입니다. 자세한 단계별 지침은 CJA API의 시작 섹션에 포함되어 있습니다.
2단계: 설정 테스트
코드를 작성하지 않고도 API를 테스트하는 좋은 방법은 강력하고 사용하기 쉬운 도구인 Postman을 사용하는 것입니다. 애플리케이션을 실행한 후 API 자격 증명을 쉽게 가져오고 간단한 GET 요청으로 실험을 시작하여 연결과 인증이 제대로 작동하는지 확인할 수 있습니다. GET 요청으로 API 테스트 여정을 시작하는 것이 좋습니다. GET 요청은 수정 없이 서버에서 데이터만 검색하기 때문에 더 안전하고 파괴적이지 않은 것으로 간주되기 때문입니다. 이는 서버의 데이터를 변경하거나 제거할 수 있는 POST, PUT, DELETE 요청과 같은 다른 HTTP 메서드와는 대조적이기 때문에 더 많은 주의가 필요합니다.
첫 번째 API 호출 수행
간단한 작업을 해보겠습니다. CJA 계정에서 사용 가능한 데이터 보기 목록을 가져옵니다.
예: 데이터 보기 목록
Endpoint:
GET https://cja.adobe.io/data/dataviews
Headers:
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG_ID}
Authorization: Bearer {AUTHORIZATION_TOKEN}
CURL Request:
curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\
-H "x-api-key: {API_KEY}" \
-H "x-gw-ims-org-id: {IMS_ORG_ID}" \
-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"
CJA API 엔드포인트 문서에서 Try It 기능을 사용하여 이러한 요청을 시도해 볼 수도 있습니다. 위의 요청을 시도하기 위한 링크입니다.
Try It CTA를 클릭하고 모든 필수 매개변수를 입력합니다. 이 경우 앞서 설명한 헤더 매개변수를 입력하고 보내기 를 클릭합니다.
요청을 사용자 정의하는 추가 매개변수를 포함할 수도 있습니다. 사용 가능한 매개변수 목록은 CJA API 설명서의 각 API 요청에 대한 쿼리 매개변수 섹션에서 찾을 수 있습니다.
다음은 API 작업 시 발생하는 주요 HTTP 응답 코드입니다.
- 200: Success — 서버가 요청을 처리하고 데이터를 반환했습니다.
- 404: Not Found — 서버가 요청한 리소스를 찾을 수 없습니다.
- 500: Internal Server Error — 서버 측에서 오류가 발생했습니다.
이러한 상태 코드는 개발자에게 API 요청 중에 정확히 무슨 일이 일어났는지 알려주므로 문제 해결이 더 쉬워집니다.
API를 처음 사용하는 사용자를 위한 팁
- 액세스 확인: 올바른 수준의 권한이 있는지, 올바른 제품 프로필에 추가되었는지 확인하세요. API 요청이 실패하는 가장 흔한 근본 원인은 올바른 액세스 권한이 없는 것입니다.
- 테스트, 테스트, 테스트: 코드를 작성하기 전에 API 엔드포인트 설명서의 Try It 기능이나 Postman을 사용하여 요청을 실험해 보세요.
- 작게 시작: 간단한 GET 요청부터 시작해서 POST 쿼리까지 진행하세요.
- 설명서 사용: Adobe의 CJA API 설명서가 가장 좋은 친구입니다. 주요 업데이트 후에는 이전 구성이 예상대로 작동하지 않을 수 있으므로, 정기적으로 업데이트를 확인하세요.
- 질문하기: 도움이 필요하면 Experience League Adobe Analytics 커뮤니티에 언제든지 연락하세요.
Adobe CJA API를 시작하는 것이 처음에는 어려울 수 있지만, 조금만 연습하면 곧바로 워크플로우를 자동화하고 인사이트를 발견할 수 있습니다. 그러니 첫 번째 단계를 밟아 로그인하고 자격 증명을 받고 간단한 API 호출을 시도해 보세요. API 모험이 여러분을 기다립니다!