인게임상점 카테고리 리스트를 조회합니다.
기본정보
GET /bill-store/v1.0/{{service_id}}/product/categories
Host:
https://api.onstove.com (LIVE)
https://api.gate8.com (SB)
Content-Type: application/json
JavaScript
복사
Request
Header
Name | Type | Required | Default Value | Example | Description |
authorization | String | N | - | {access_token} | 사용자의 인증을 통해 발급 되는 access token
※ Web에서는 “SUAT 쿠키값” 사용 |
X-Lang | String | Y | - | ko | 언어 코드 |
X-Nation | String | Y | - | KR | 국가 코드 |
X-Timezone | String | Y | - | Asia/Seoul | Timezone |
X-Utc-Offset | Int32 | Y | - | 540 | UTC Offset |
caller-id | String | Y | - | clientapp | API 호출자 정보
예) 서비스명_GAME_SERVER |
Path Variable
Name | Type | Required | Default Value | Example | Description |
service_id | String | Y | - | GAME_ID | 스튜디오에서 발급된 게임ID |
Paramater (Query String)
Name | Type | Required | Default Value | Example | Description |
shop_key | String | Y | - | indie | 인게임상점의 상점키 |
category_parent_id | String | N | - | 061A30EC8C904CA | 부모 카테고리 키
• NULL 일 경우 전체 카테고리 응답 |
category_depth | Int32 | N | - | 1 | 카테고리 뎁스
• 최 상위 뎁스: 1 |
Response
Body
Name | Type | Required | Default Value | Example | Description |
code | Integer | Y | - | 0 | 응답 코드 |
message | String | Y | - | OK | 응답 메시지 |
value | Object | N | - | 응답 값 |
Value
Name | Type | Required | Default Value | Example | Description |
total_count | Int | Y | - | 10 | 총 카운트 |
list | Object | Y | - | 리스트 |
List
Name | Type | Required | Default Value | Example | Description |
category_id | String | Y | - | 061A30EC8C904CA | 카테고리 키 |
category_parent_id | String | N | - | D55DD291CAAA459 | 부모 카테고리 키 |
category_display_no | Int32 | Y | - | 1 | 카테고리 순서 |
category_name | String | Y | - | 카테고리A | 카테고리 명
• 다국어 지원 |
category_depth | Int32 | Y | - | 1 | 카테고리 뎁스 |
Sample
Request
curl --location --request GET'https://api.onstove.com/bill-store/v1.0/{{service_id}}/product/categories?shop_key=indie' \
--header 'Authorization: Bearer {{access_token}}'
--header 'X-Lang: ko'
--header 'X-Nation: KR'
--header 'X-Timezone: Asia/Seoul'
--header 'X-Utc-Offset: 540'
--header 'caller-id: {{caller-id}}'
JavaScript
복사
Response
Content-Type : application/json
{
"value":{
"total_count":2,
"list":[
{
"category_id":"061A30EC8C904CA",
"category_parent_id":null,
"category_display_no":"1",
"category_name":"카테고리 A",
"category_depth": 1
},
{
"category_id":"D55DD291CAAA459",
"category_parent_id":"061A30EC8C904CA",
"category_display_no":"1",
"category_name":"카테고리 A-A",
"category_depth": 1
}
]
},
"code":0,
"message":"OK"
}
JavaScript
복사
응답 실패 예제
{ "code": "999999", "message": "정의되지 않은 오류입니다."}
JavaScript
복사
Return Code
HTTP Status code | response_code | response_message | Description |
200 | 0 | OK | 성공 |
200 | 999999 | 정의되지 않은 오류입니다. | 아이템 샵 API 오류 |
500 | 500 | Internal Server Error | 서버 내부 오류 |