Skip to content

관리자 페이지 제공하기 ​

스토어 관리자 페이지에서 앱의 기능을 사용할 수 있는 앱 관리자 페이지를 제공할 수 있어요.

관리자 페이지 노출하기 ​

  1. 앱 개발자 센터에서 설정하려는 앱의 앱 동작 페이지로 이동해주세요.
  2. 앱 관리 화면 설정 섹션의 앱 관리자 페이지 주소(URL)을 사용으로 설정하고 관리자 페이지의 URL을 입력해주세요.
  3. 저장 버튼을 눌러 설정을 저장해주세요.

저장이 완료된 뒤에 앱이 설치된 스토어의 앱 설정 페이지에서 {앱이름} 설정 바로가기 버튼을 통해 앱 관리자 페이지로 바로 이동할 수 있어요.

SSO 적용하기 ​

식스샵 프로 플랫폼에서는 운영자의 로그인 상태를 앱 관리자 페이지와 연동할 수 있는 SSO(Single Sign-On) 기능을 제공하고 있으며, 다음과 같은 상황에 사용할 수 있어요:

  • 앱 자체 회원가입/로그인 기능 없이, 운영자의 로그인 상태를 앱 관리자 페이지에서 사용하려는 경우
  • 앱 자체 회원가입/로그인 기능이 존재하지만, 식스샵 프로에서 로그인한 운영자 계정과 연동하여 가입/로그인 절차를 간소화하거나 자연스러운 UX를 제공하고 싶은 경우

⚠️ SSO를 적용하기 위해선 식스샵 API를 호출할 수 있는 앱 엑세스 키가 필요해요

앱 엑세스 키를 획득하는 방법과 기본적인 API 사용법은 API 사용하기 문서를 참고해주세요.

SSO 연동 흐름 ​

#1. 유저 인증 토큰 획득을 위한 임시 키(Key) 전달받기 ​

앱을 설치한 스토어에서 운영자가 {앱이름} 설정 바로가기 버튼을 클릭하면, 식스샵 프로 플랫폼에서 앱 관리자 페이지로 리디렉션되면서 다음과 같은 Query String이 전달돼요.

임시 키 전달: REDIRECT {APP_PAGE_URL}?key={USER_TEMP_KEY}&storeId={STORE_ID}
  • key: 유저 인증 토큰 획득을 위해 발급되는 임시 키(1분 후에 만료)가 전달돼요.
  • storeId: 어떤 스토어인지가 전달돼요.

#2. 유저 인증 토큰 획득하기 ​

전달된 USER_TEMP_KEY와 STORE_ID를 활용하여, 앱 서버에서 유저 인증 토큰 획득 API를 호출하면 운영자 인증에 필요한 인증 토큰을 전달받을 수 있어요.

인증 토큰 획득: POST https://api.sixshop.io/user-store/api/auth/app
yaml
# Headers
Authorization-Core: <ACCESS_KEY>  # 앱 엑세스 키
SS-Store-ID: <STORE_ID>           # 스토어 ID

# Body (application/json)
{
  "key": "<USER_TEMP_KEY>",   # 유저 인증 토큰 획득용 임시 키
  "appName": "<APP_NAME>"     # 앱 고유 식별자
}

# Response (200)
{
  # ...
  "data": {
    "storeName": "<STORE_ID>",    # 스토어 ID
    "userId": "<USER_ID>",        # 유저 고유 식별자
    "userToken": "<USER_TOKEN>"   # 유저 인증 토큰 (30일 뒤 만료)
  }
}
앱 식별자(appName)는 어디서 확인할 수 있나요?
  • appName 은 앱을 구분하는 고유 식별자예요.
  • 앱 개발자 센터의 앱 동작 페이지 내 앱 식별자 섹션에서 확인할 수 있어요.
  • 비공개 앱에서 공개 앱으로 전환되는 경우에는 appName이 새롭게 변경되어 부여될 수 있어요.

⚠️ 유저 토큰은 JWT 형식이지만 파싱해서 사용하는 건 권장하지 않아요

식스샵 프로 플랫폼 정책에 따라 다른 형식으로 변경될 가능성이 있기 때문에, 전달받은 토큰 내용을 직접 파싱하여 사용하는 부분은 지양해주세요.

#3. 유저 인증 토큰 유효성 검증 ​

획득한 유저 인증 토큰을 활용하여, 앱 서버에서 유저 인증 토큰 유효성 검증 API를 호출하면 운영자 인증이 정상적으로 완료되었는지 확인할 수 있어요.

유효성 검증: GET https://api.sixshop.io/user-store/api/token
yaml
# Headers
Authorization-Core: <ACCESS_KEY>  # 앱 엑세스 키
SS-Store-ID: <STORE_ID>           # 스토어 ID
SS-User-ID: <USER_ID>             # 유저 고유 식별자
SS-User-Token: <USER_TOKEN>       # 유저 인증 토큰 (30일 뒤 만료)

# Response (200)

#4. 스토어 및 운영자 정보 조회 ​

필요한 경우 스토어 및 운영자 정보를 조회해 계정 연동이나 가입/로그인 처리 과정에 활용할 수 있어요.

스토어 정보 조회: GET https://api.sixshop.io/store-manager/v1/app/store
yaml
# Headers
Authorization-Core: <ACCESS_KEY>  # 앱 엑세스 키
SS-Store-ID: <STORE_ID>           # 스토어 ID

# Response (200)
{
  # ...
  "data": {
    "displayName": "스토어명",        # 스토어 디스플레이명
    "name": "hello-sixshop",         # 스토어 ID
    "domain": "hello.sixshop.site"   # 스토어 도메인 - 기본 도메인(*.sixshop.site) 혹은 커스텀 도메인(example.org)
  }
}
운영자 정보 조회: GET https://api.sixshop.io/store-manager/v1/app/users/{userId}
yaml
# Headers
Authorization-Core: <ACCESS_KEY>  # 앱 엑세스 키
SS-Store-ID: <STORE_ID>           # 스토어 ID

# Response (200)
{
  # ...
  "data": {
    "userType": "소유자", # "소유자" 또는 "운영자"
    "userId": "b2934bf8-1a1a-421e-93ed-4b23fb528f07",
    "email": "hello@sixshop.com",
    "name": "김식스",
    "phoneNumber": "010-1111-2222"
  }
}

#5. 유저 인증 토큰 만료 시 재인증 요청하기 ​

유저 인증 토큰이 만료되었다면, 스토어 운영자를 인증 페이지로 리디렉션하여 재인증을 요청할 수 있어요.

재인증 요청: REDIRECT https://store.sixshop.com/verify/external-app?appName={APP_NAME}&redirectPath=/
  • appName: 앱 고유 식별자예요.
  • redirectPath: 식스샵 프로에서 유저가 인증한 이후, 다시 앱 화면으로 리디렉션되는 경우 사용되는 패스(Path)예요.
앱 식별자(appName)는 어디서 확인할 수 있나요?
  • appName 은 앱을 구분하는 고유 식별자예요.
  • 앱 개발자 센터의 앱 동작 페이지 내 앱 식별자 섹션에서 확인할 수 있어요.
  • 비공개 앱에서 공개 앱으로 전환되는 경우에는 appName이 새롭게 변경되어 부여될 수 있어요.

인증이 완료된 경우 #1 절차와 동일한 방식으로 임시 키가 전달되고, #2 절차와 동일하게 인증 토큰을 다시 획득할 수 있어요.

전체 흐름도 ​

Sixshop Developers Portal