💡 이 문서는 크리마 리뷰 API 키 발급 및 권한 설정 방법에 대해 안내합니다.
핵심 요약
- 크리마의 리뷰 데이터를 연동하여 사용하려면 API 키 발급이 필요합니다.
- API 키는 관리자 페이지에서 이름과 사용 목적에 맞는 권한을 설정하여 발급할 수 있습니다.
- 발급된 App ID와 Secret Key를 활용하여 Access Token을 얻을 수 있습니다.
- 권한 설정에 따라 리뷰 데이터의 읽기/쓰기/삭제 가능 범위가 달라지므로 신중하게 설정해야 합니다.
STEP 1. API 키 발급하기
1. API 키 발급 탭에서 'API 키 발급' 버튼을 클릭합니다.
2. API 키의 이름과 권한 설정을 입력한 후 'API 키 발급' 버튼을 누릅니다.
3. 발급된 API 키는 API 키 발급 탭에서 확인할 수 있습니다. '키 확인' 버튼으로 키 정보를 확인할 수 있습니다.
4. App ID와 Secret Key를 이용하여 Access Token을 발급할 수 있습니다.
STEP 2. 권한 설정 안내
API 키 발급 시 설정할 수 있는 권한은 크게 제한된 권한과 모든 권한으로 나뉩니다. 목적에 맞게 설정해 주세요.
-
제한된 권한
리뷰 데이터 중 일부 항목만 읽을 수 있도록 제한하는 설정입니다.
-
외부 업체 공유: 광고 대행사 등 외부 업체와 크리마 리뷰 데이터를 공유할 때 추천합니다.
- 리뷰 데이터의 기본 리뷰만 읽을 수 있게 제공됩니다.
- 포토 리뷰가 있는 경우, 얼굴은 모자이크 처리됩니다.
- 선택적으로 리뷰 댓글 읽기 권한을 사용할 수 있습니다.
-
내부 사용: 내부에서 크리마 리뷰 데이터를 공유할 때 추천합니다.
- 리뷰 데이터의 모든 데이터를 읽을 수 있게 제공됩니다.
- 포토 리뷰가 있는 경우, 얼굴은 모자이크 처리되지 않습니다.
- 선택적으로 리뷰 댓글 읽기 권한을 사용할 수 있습니다.
- 직접 선택: 제한된 권한에 대해 항목을 직접 선택할 수 있습니다.
제한된 권한에서 읽을 수 있는 항목:
- id, code, product_id, product_code, created_at, message, score, user_name, display
-
외부 업체 공유: 광고 대행사 등 외부 업체와 크리마 리뷰 데이터를 공유할 때 추천합니다.
-
모든 권한
고객사의 모든 크리마 데이터를 읽기, 쓰기, 삭제할 수 있는 권한입니다.
- 🚫 주의: 무단 사용을 방지하려면 API 사용 권한을 제한하는 것이 좋습니다.
- 모든 권한 부여를 원하시면 크리마 리뷰 운영팀으로 권한 필요 사유와 함께 문의해 주시기 바랍니다.
STEP 3. API 사용 안내
크리마 리뷰 API 사용에 대한 자세한 내용은 아래 CREMA DEV 페이지를 참고해 주세요.
-
CREMA DEV 페이지
- CREMA 서비스를 위한 데이터 업로드/다운로드 방법을 제공하며, HTTP/1.1 REST API 규약을 따릅니다.
자주 묻는 질문 (FAQ)
Q. API 키는 어떻게 발급받을 수 있나요?
👉 관리자 페이지 > 프로필 하단 > 설정 > API 키 발급 메뉴에서 'API 키 발급' 버튼을 클릭하여 발급할 수 있습니다. 키의 이름과 권한을 설정한 후 발급합니다.
Q. API 키 발급 시 어떤 권한을 설정할 수 있나요?
👉 API 키 발급 시 '제한된 권한'과 '모든 권한' 중 하나를 선택할 수 있습니다. 제한된 권한은 다시 '외부 업체 공유', '내부 사용', '직접 선택'으로 세분화됩니다.
Q. '제한된 권한'과 '모든 권한'의 주요 차이점은 무엇인가요?
👉 '제한된 권한'은 리뷰 데이터의 특정 항목만 읽을 수 있도록 접근을 제한하며, 포토 리뷰의 얼굴 모자이크 처리 여부 등을 선택할 수 있습니다. 반면 '모든 권한'은 고객사의 모든 크리마 데이터를 읽고, 쓰고, 삭제할 수 있는 강력한 권한으로, 신중하게 사용해야 합니다.
Q. 발급받은 API 키로 Access Token은 어떻게 사용하나요?
👉 발급받은 App ID와 Secret Key를 이용하여 Access Token을 발급받을 수 있습니다. 자세한 내용은 CREMA DEV 페이지를 참고해 주십시오.