테마
설치 및 삭제 요청 처리
스토어에서 앱을 설치하거나 삭제하는 경우 앱 서버에서 상태 변화를 전달받을 수 있어요.
상태 변화 전달받기
앱의 상태 변화를 전달받기 위해서는 몇 가지 설정이 필요해요.
- 앱 개발자 센터에서 설정하려는 앱의 앱 동작 페이지로 이동해주세요.
- 앱 서버 호스트를 사용으로 설정하고 호출받을 서버 Host 주소(예:
https://example.org)를 입력해주세요. - 앱 상태 전달용 엔드포인트를 사용으로 설정하고 호출받을 서버의 엔드포인트(예:
/app/state)를 입력해주세요. - 저장 버튼을 눌러 설정을 저장해주세요.
저장이 완료된 뒤에 테스트에 사용 중인 스토어에서 앱을 설치/삭제하시면 설정한 앱 서버의 엔드포인트로 이벤트가 전달돼요.
엑세스 키(Access Key) 함께 전달받기
만약 개발하려는 앱에서 식스샵에서 제공하는 API를 연동해 사용하려는 경우에는 설치와 함께 API 사용을 위한 엑세스 키를 전달받을 수 있어요.
- 설정하려는 앱의 앱 동작 페이지로 이동해주세요.
- 앱 엑세스 키(Access Key) 획득 방식 설정을 서버 호출(POST) 전달로 설정해주세요.
- 저장 버튼을 눌러 설정을 저장해주세요.
저장이 완료된 뒤에 앱을 설치하면, 앱 서버의 엔드포인트로 설치 이벤트가 전달될 때 엑세스 키가 함께 전달돼요.
앱 설치 요청 처리하기
특정 스토어에서 앱을 설치하면, 설치 상태가 담긴 POST 요청이 전달돼요.
yaml
# Headers
SS-Store-ID: <STORE_ID> # 스토어 ID
# Body (application/json)
{
"state": "installed", # 설치 상태
"key": "<ACCESS_KEY>" # 엑세스 키 - 서버 호출(POST) 전달로 설정된 경우
}- 앱 설치 이벤트는 스토어별로 전달되고,
SS-Store-ID헤더로 스토어를 구분할 수 있어요. - 엑세스 키도 설치한 스토어별로 전달돼요. 만약 100개 스토어에서 앱을 설치했다면 100개의 별도 엑세스 키가 전달돼요.
- 전달받은 스토어 ID와 엑세스 키는 이후 앱에서 설치 여부를 판별하거나 식스샵 API를 사용하는 경우 필요하므로 반드시 저장하고 관리해야 해요.
- 설치 이벤트 호출에 대한 응답으로
4xx5xx상태 코드가 반환되면, 전달 실패로 보고 식스샵에서 재호출(Retry)을 진행하게 돼요.
⚠️ 스토어 ID와 엑세스 키를 저장하는 경우 Upsert 방식을 권장해요
상태 전달 실패에 의한 재시도(Retry) 상황이나 보안상 이유로 엑세스 키가 재발급되는 상황에서, 동일 스토어에 대한 요청이 다시 전달될 수 있기 때문에 Upsert 방식으로 저장하는 구현 방식을 권장해요.
앱 삭제 요청 처리하기
설치된 앱이 삭제되면, 동일한 엔드포인트로 삭제 상태가 담긴 POST 요청이 전달돼요.
yaml
# Headers
SS-Store-ID: <STORE_ID> # 스토어 ID
# Body (application/json)
{
"state": "deleted" # 삭제 상태
}삭제 요청에 응답하는 HTTP 상태 코드에 따라 처리 방식이 달라져요.
200 OK로 응답하면 앱이 해당 스토어에서 즉시 삭제돼요.202 Accepted로 응답하면 앱이 즉시 삭제되지 않고 삭제 대기 상태로 진입해요.- 삭제 대기 상태에서 필요한 후처리(클린업 등)를 진행한 뒤, 앱 삭제 처리 완료 API를 호출하면 앱이 최종 삭제돼요.
- 앱 삭제 요청 시 처리해야할 과정이 많은 경우에 사용할 수 있는 방식이에요.
⚠️ 앱 삭제가 요청된 경우에는 저장하고 있는 스토어 관련 정보를 삭제해주세요
앱 삭제는 스토어에서 명시적으로 앱 사용을 중단하겠다는 의사 표현이기 때문에, 삭제 요청이 전달된 경우에는 해당 스토어에 대해 저장한 정보들을 완전히 삭제(클린업)하기를 권장해요.
앱 삭제 처리 완료 API
POST https://api.sixshop.io/{appName}/_/deleted
yaml
# Headers
Authorization-Core: <ACCESS_KEY> # 엑세스 키
SS-Store-ID: <STORE_ID> # 스토어 ID
# Response (204)앱 식별자(appName)는 어디서 확인할 수 있나요?
appName은 앱을 구분하는 고유 식별자예요.- 앱 개발자 센터의 앱 동작 페이지 내 앱 식별자 섹션에서 확인할 수 있어요.
- 비공개 앱에서 공개 앱으로 전환되는 경우에는
appName이 새롭게 변경되어 부여될 수 있어요.
