업데이트 내역
Untitled
개요
식스샵 프로의 웹사이트에 앱이 제공하는 UI 요소들을 판매자가 에디터에서 사용 및 설정 하기 위해 필요한 연동/개발을 소개합니다.
사전 준비
- API 기본 호스트:
https://api.sixshop.io/sf-gateway
- 필수 헤더
ss-store-id : 스토어 고유 식별자
Authorization-core : 스토어 별 앱 인증키
개념 설명
스토어
에디터
웹사이트(쇼핑몰)
앱
에디터를 위한 앱 설정 (이하 “에디터 앱 설정”)
API
<aside>
☝ 확인해 주세요!
파란 블럭은 식스샵 프로에서 제공하는 API 입니다.
녹색 블럭은 앱에서 개발/제공 해야하는 API 입니다.
</aside>
에디터 앱 설정 등록/수정
- 특정 스토어에서 유저가 앱을 설치 및 사용하는 경우, 스토어 별로 에디터 앱 설정을 초기 등록해야합니다.
- 초기 등록 시점은 앱의 비지니스에 따라 UX를 고려하여 적절한 시점에 호출해주시면 됩니다.
- 에디터 앱 설정이 진행되지 않으면 시스템상 에디터에서 정상 사용이 불가능할 수 있습니다.
- 만약 에디터 앱 설정에 변경이 필요한 경우에도 등록과 동일한 API를 통해서 수정할 수 있습니다.
- 시퀀스 다이어그램
- Request
- Response
에디터 앱 설정 삭제
- 특정 스토어의 유저가 앱 사용을 중지(삭제)한 경우에 에디터 시스템에게 알림(호출)이 필요합니다.
- 삭제 시점은 앱의 비지니스에 따라 UX를 고려하여 적절한 시점(앱이 스토어에서 제거되거나 연동 해제되는 경우 등)에 호출해주시면 됩니다.
- 해당 API가 호출되면 에디터에 해당 앱과 관련된 UI가 없어지며, 웹사이트에서도 숨겨지게 됩니다.
- 시퀀스 다이어그램
- Request
- Response
컴포넌트 동기화 - 컴포넌트 변경 감지 훅 API
- 특정 스토어에 제공하는 컴포넌트에 변화가 생겨 동기화가 필요한 시점에 해당 API를 호출해주시면, 에디터 시스템은 해당 스토어에 대해 컴포넌트를 동기화합니다.
- 최초에 에디터 앱 설정이 등록된 경우*(참고: 에디터 앱 설정 등록/수정)*에 초기 제공 컴포넌트를 동기화하기 위해서 호출할 수 있습니다.
- 제공 중인 컴포넌트의 변화가 있는 경우(추가, 수정, 삭제 등) 컴포넌트를 동기화하기 위해서 호출할 수 있습니다.
- 상기 API가 호출되면 식스샵 프로는 앱의 syncUrl 을 호출하고, 응답된 데이터를 기반으로 컴포넌트를 동기화합니다.
- 컴포넌트를 통기화하는 과정은 호출 즉시 일어나지 않고 비동기적으로 일어납니다.
- 시퀀스 다이어그램
- Request
- Response
🆕 컴포넌트 setting(에디터 패널 요소) 검증 API
- 에디터내 패널 UI를 구성할 수 있는
setting 이 올바른지 validation 검증을 하는 API 입니다.
- 에디터에서 제공하는
setting은 스키마가 정해져 있으며, 올바르지 않으면 에디터내에 노출되지 않을 수 도 있습니다.
- 따라서, setting을 제공하고자 한다면 필히 해당 API를 통해 검증 후 컴포넌트 동기화를 해주셔야 합니다.
- 필요하다면, 비지니스 로직등에 적절한 시점에 해당 API를 호출해서 사용하시면 됩니다.
- 해당 API는 검증만 할뿐, 생성/수정을 하지 않습니다.
- Request
- Response
컴포넌트 동기화 - 컴포넌트 목록 조회 API(동기화 용)
- 컴포넌트 동기화 - 컴포넌트 변경 감지 훅 API 가 호출되거나, 식스샵 프로 시스템에서 동기화가 필요하다고 판단되는 경우 호출됩니다.
- 앱에서 개발 및 제공이 필요한 API이며, 개발자센터를 통해 앱의 API로 등록이 필요합니다.
- 컴포넌트 동기화 - 컴포넌트 변경 감지 훅 API 의 시퀀스 다이어그램의 5~7 과정에 사용됩니다.
- 에디터 앱 설정 등록/수정 에서 설정한
syncUrl 에 해당하는 API이며 GET 요청으로 호출됩니다.
- 현 시점에는 페이지네이션 없이 모든 컴포넌트 응답이 필요합니다.
- 응답에서 생략된 컴포넌트들은 동기화 과정에서 자동 삭제되니 주의해 주세요.
- 응답을 아래의 Response 형식으로 꼭 맞춰주셔야하며, 응답 형식이 맞지 않는 경우 동기화가 일어나지 않습니다.
- Request
- Response