유사 상품 검색 사용 가이드

사전 작업

카카오 i 클라우드의 유사 상품 검색 API를 사용하기 위해서는 조직 소유자 또는 조직 관리자가 카카오 i 클라우드 콘솔에서 클라우드 조직 계정 및 프로젝트 생성, 사용자 초대, 조직 및 프로젝트 역할 추가 등의 작업을 완료해야 합니다. 따라서 카카오 i 클라우드 콘솔 또는 프로젝트에 접근 권한이 없는 경우, 조직 소유자/관리자 또는 프로젝트 관리자에게 사용자 등록 또는 프로젝트 역할 추가를 요청하시기 바랍니다.

안내
사용자 초대 및 프로젝트 역할 추가 관련 프로세스는 Kakao i Cloud Console > 관리자 가이드를 참고하시기 바랍니다.

유사 상품 검색 API 시작하기

유사 상품 검색 API를 사용하려면 도메인 만들기, 인증정보 획득 및 API 호출 작업을 단계적으로 수행해야 합니다. API를 일정량 이상 사용하지 않도록 제한하고 싶다면 API 한도 설정을 추가로 진행하시기 바랍니다.

Step 1. 도메인 만들기

도메인이란 API를 호출하는 서비스의 단위이며, 카카오 i 클라우드 콘솔에서 발급받을 수 있습니다. 콘솔에서 서비스별 도메인을 생성해야 API 호출 시 필요한 암호화된 API Key 정보를 발급받을 수 있으며, API Endpoint URL도 생성할 수 있습니다. 도메인 생성 방법은 다음과 같습니다.

1. 카카오 i 클라우드 콘솔에서 좌측 상단 [메뉴] 아이콘을 클릭합니다.
2. 전체 서비스의 Vision 메뉴를 선택합니다.
3. 서비스 탭에서 시작할 서비스로 유사 상품 검색을 선택합니다.
4. 서비스 이용 시작 팝업창에서 [도메인 만들기] 버튼을 클릭합니다.

5. 도메인 만들기 팝업창에서 생성할 도메인 내용을 입력합니다.

   

   이미지 도메인 정보 입력

   구분	필수 여부	설명
   서비스	필수	유사 상품 검색 선택
   도메인 이름	필수	해당 도메인의 이름 - 영어 소문자로 시작해야 함 - 4-30자의 영문 소문자, 숫자, - 만 입력 가능
   도메인 설명	선택	해당 도메인에 대한 상세 설명 - 60자까지 입력 가능

6. 도메인 탭에서 생성한 도메인을 확인합니다.

   

   이미지 도메인 생성 확인

Step 2. 인증정보 획득하기

도메인을 생성하면, API 호출 시에 필요한 API Key와 API Endpoint URL을 발급받을 수 있습니다

1. 카카오 i 클라우드 콘솔에서 좌측 상단 [메뉴] 아이콘을 클릭합니다.
2. 전체 서비스의 Vision 메뉴를 선택합니다.
3. 도메인 탭에서 생성한 도메인의 [인증 정보] 버튼을 클릭합니다.

4. API 인증정보 팝업창에서 API Key와 API Endpoint URL 정보를 확인합니다.

   

   이미지 API 인증 정보

   구분	설명
   API Key	API Endpoint URL 호출에 필요한 API의 고유한 키 정보로 암호화하여 제공 - 재발급받을 경우 기존 API Key는 폐기됨
   API Endpoint URL	API 호출 시에 사용하는 API Endpoint URL 주소

Step 3. API 한도 설정하기 (선택)

필요시 API 사용 한도를 설정할 수 있습니다. 별도로 API 한도를 설정하지 않는다면, 기본으로 지정된 최대한도까지 사용할 수 있습니다. 설정 한도를 초과할 경우에는 API 사용이 제한됩니다.

1. 카카오 i 클라우드 콘솔에서 좌측 상단 [메뉴] 아이콘을 클릭합니다.
2. 전체 서비스의 Vision 메뉴를 선택합니다.
3. 도메인 탭에서 생성한 도메인의 [한도 설정] 버튼을 클릭합니다.

4. API 사용 한도 설정 (선택) 팝업창에서 API 한도를 설정합니다.

   

   이미지 API 사용 한도 설정

   구분	설명
   일별 한도	일별 API 사용 한도 - 최대값: 34,560(기본값)
   월별 한도	월별 API 사용 한도 - 최대값: 1,036,800(기본값)

Step 4. API 사용하기

위 작업을 모두 완료하면 API Reference를 참고하여 API를 사용합니다.

안내
유사 상품 검색 도메인을 생성하면 오토 태깅 기능은 곧바로 사용할 수 있습니다. 그 외 이미지 검색이나 ID 검색 기능을 사용하시려면 헬프데스크 > 기술 문의를 통해 최초 색인을 위한 설정을 요청하시기 바랍니다.

도메인 수정하기

도메인 정보를 수정할 수 있습니다.

1. 카카오 i 클라우드 콘솔에서 좌측 상단 [메뉴] 아이콘을 클릭합니다.
2. 전체 서비스의 Vision 메뉴를 선택합니다.

3. 도메인 탭에서 수정할 도메인의 [더보기] 아이콘을 클릭하고, 도메인 수정을 클릭합니다.

   

   이미지 도메인 수정 선택

4. 도메인 수정 팝업창에서 도메인 이름 및 설명을 수정하고 [수정] 버튼을 클릭합니다.

   

   이미지 도메인 수정 진행

도메인 삭제하기

더 이상 서비스를 이용하지 않으려면 생성한 도메인을 삭제합니다.

주의
도메인 삭제 시, API Key와 API Endpoint URL이 모두 삭제되며 이는 복원할 수 없습니다.

1. 카카오 i 클라우드 콘솔에서 좌측 상단 [메뉴] 아이콘을 클릭합니다.
2. 전체 서비스의 Vision 메뉴를 선택합니다.

3. 도메인 탭에서 삭제할 도메인의 [더보기] 아이콘 > 도메인 삭제를 클릭합니다.

   

   이미지 도메인 삭제 선택

4. 도메인 삭제 팝업창에 삭제할 도메인 이름을 입력하고 [삭제] 버튼을 클릭합니다.

   

   이미지 도메인 삭제 진행