등록
이해하기
쇼핑몰 설치형 앱을 등록하여 systemKey 발급받아 serverAPI를 호출하고, 쇼핑몰 관리자 설치할 수 있습니다.
아래 프로세스에 따라 앱을 개발해보세요.
본 가이드는 셀러어드민 내 앱 등록에 대해 안내합니다.
앱 개발을 시작하거나, 인증키(systemKey)를 발급받기 위해서는 셀러어드민에 앱을 등록해야 합니다.
등록
앱 등록 시에는 API 호출 여부를 포함하여 목적에 따라 ① 쇼핑몰 설치형 ② 신청 사이트 연결형 중 선택하여 앱을 등록해야 합니다.
- ① 쇼핑몰 설치형
- 앱 등록 시 선택한 연동 솔루션에서 제공하는 server API 를 호출할 때 필요한 정보가 발급되는 앱의 유형으로 API 호출에 필요한 개발 정보를 입력해야 합니다.
앱이 쇼핑몰에 설치되면 쇼핑몰 데이터에 대한 권한(읽기-GET/쓰기-POST,PUT,DELETE)을 가질 수 있습니다. - '쇼핑몰 설치형'앱은 등록한 직후 바로 내 쇼핑몰에 설치할 수 있는 '내 쇼핑몰 전용앱'으로 등록됩니다.
앱을 내 쇼핑몰에 설치하여 서비스를 이용하거나 개발 테스트를 진행할 수 있고, '판매앱'으로 전환하여 스토어에한 판매할 수 있습니다. - ② 신청 사이트 연결형
- 서비스 제공을 위해 별도로 개발할 필요 없이 단순히 사이트에서 신청하여 사용하는 앱의 유형으로 판매 정보만 입력하면 됩니다.
앱 등록 이후에도 쇼핑몰 설치가 불가한 앱이기 때문에 쇼핑몰 데이터에 대한 권한을 가질 수 없습니다. - '신청 사이트 연결형'앱은 등록 시 '판매앱'으로 등록되기 때문에 등록 직후 심사절차를 거쳐 스토어에서 판매할 수 있습니다.
해당 앱을 등록하는 경우에는 앱 개발 가이드에 포함된 스토어 출시하기 가이드를 확인해 주시기 바랍니다.
[1] 기본정보
- ① 앱이름
앱구분을 위한 관리용 앱이름을 입력하는 항목입니다. 스토어에 노출될 상품명은 판매정보 입력 시 지정 가능합니다.
- ② 앱 URI
쇼핑몰에 설치된 앱이 실행될 때 출력되는 도메인 주소를 입력하는 항목입니다.
- ③ redirect URI
토큰 발급을 위해 필요한 유효성 검증용 파라미터를 입력하는 항목입니다.
최대 10개까지 입력 가능하며, 반드시 https:// 프로토콜을 사용하는 도메인이어야 합니다. - ④ 연동 솔루션
앱을 연동할 솔루션을 설정하는 항목입니다.
샵바이와 고도몰 중 1개 이상 선택해야 하며, 각 솔루션에 필요한 연동정보가 입력되어야 합니다. - ⑤ 공통 웹훅(Webhook)
앱과 관련한 이벤트가 발생했을 때 알림을 설정하는 항목입니다.
자세한 내용은 아래 웹훅 가이드 문서를 참고해 주시기 바랍니다.위 항목에서 설정 가능한 웹훅은 샵바이와 고도몰 솔루션에서 공통으로 사용되는 웹훅입니다.
따라서, 선택한 연동 솔루션이 2개 이상이더라도 해당 웹훅은 수신할 URL은 1개만 입력되어야 합니다. - ⑥ IP 설정
server API를 호출할 IP 를 등록하는 항목입니다.
IP는 최대 50개까지 등록 가능하며, 등록된 IP에서만 server API를 호출할 수 있습니다.
고정된 IP에서만 호출이 가능하기 때문에 고정된 IP로 호출이 어려운 경우 프록시 서버를 사용해야 합니다.
[2] 샵바이/고도몰 연동정보
- ① 서비스 지원범위
샵바이 솔루션에서 앱 동작을 지원하는 범위를 입력하는 항목입니다.
지원범위에 따라 서비스 어드민에서만 사용 가능하거나 또는 서비스 어드민과 파트너 어드민에서 모두 사용 가능합니다.- 서비스 어드민: 쇼핑몰 운영업체에 제공되는 관리자 시스템
- 파트너 어드민: 상품 판매를 목적으로 쇼핑몰에 입점하는 업체에 제공되는 관리자 시스템
- ② server API 권한
앱이 동작하는데 필요한 server API 사용권한을 신청하는 항목입니다.
server API는 쇼핑몰 데이터를 조회 또는 편집 시 사용하는 API 입니다.
serverAPI를 호출하기 위해서는 별도 권한이 필요하기 때문에 앱 등록시 사용권한을 신청해 주셔야합니다.
사용권한을 신청하지 않은 상태에서는, 관련 API 호출 자체가 불가능합니다.server API 사용권한은 도메인별로 읽기 또는 읽기+쓰기 권한으로 신청할 수 있으며, 각 솔루션에서 제공하는 server API 목록은 아래 경로에서 확인 가능합니다.
- ③ 웹훅(Webhook)
특정 이벤트가 발생했을 때 알림을 설정하는 항목입니다.
자세한 내용은 아래 웹훅 가이드 문서를 참고해 주시기 바랍니다.웹훅 사용시, 해당 이벤트와 관련된 serverAPI 권한도 함께 추가되어야 합니다.
ex) 회원정보 변경 이벤트 웹훅을 샵바이 웹훅 선택 팝업에서 선택 시, member API권한이 필요함
[3] 연동방식 선택
앱의 연동방식을 선택하는 항목으로, 앱이 동작하는데 있어서 어떠한 데이터를 호출하는 지에 따라 구분됩니다. shop API와 server API를 모두 호출한다면 모두 선택해 주시기 바랍니다.
- 데이터 연동방식 : 앱을 동작시키기 위해 server API를 호출할 경우
- shop 연동방식 : 쇼핑몰 프런트에 스크립트가 추가되는 경우
[4] 수집데이터 정보
서비스 제공을 위해 쇼핑몰 회원의 개인정보를 수집하는 경우 「개인정보보호법」에 의거하여 개인정보를 수집·이용하는 경우 개인정보의 처리 목적, 수집 항목, 보유 및 이용 기간을 고지하여야 합니다.
서비스의 본질적 기능을 수행하기 위해 반드시 필요한 개인정보만을 수집해야 하며, 수집정보를 명시해야 합니다.
별도 개인정보 처리방침 사이트가 있는 경우에도 이용 항목, 이용 목적, 이용 기간에 대한 내용은 필히 작성해 주셔야 합니다.
입력된 내용은 쇼핑몰 관리자가 앱을 설치할 때 확인할 수 있는 내용으로, 이에 동의한 회원들만 앱을 설치할 수 있습니다.
등록 완료
개발정보를 입력한 쇼핑몰 설치형 앱은 등록 직후 내 쇼핑몰에 설치할 수 있는 ‘내 쇼핑몰 전용앱’ 으로 등록되고, server API 호출 시 필요한 인증키(systemkey와 secretkey)가 발급됩니다.
발급된 인증키는 앱수정 화면에서 조회할 수 있습니다. 자세한 내용은 인증 문서를 확인해 주시기 바랍니다.