# 게임 쿠폰 등록 API
# 소개
게임 쿠폰을 등록합니다
# 기본정보
POST /coupon/v3.0/{user_token_type}/game/coupon/use
Host:
https://api.onstove.com (LIVE)
https://api.gate8.com (SB)
Content-Type: application/json
1
2
3
4
5
2
3
4
5
# Request
# Header
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| Authorization | String | Y | - | {Access Token} | 사용자의 인증을 통해 발급 되는 access token |
# Path Variable
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| user_token_type | string | Y | - | web | 유저토큰종류 공통 - 모든 타입의 토큰 사용 |
# Parameter
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| game_code | string | Y | - | STOVE_QA_ALPHA | 게임ID (플랫폼에서 부여) |
| coupon_no | string | Y | - | H370Y300R2M02YV0 | 쿠폰박스 일련번호 |
| client_ipaddr | String | Y | - | 10.5.24.52 | 회원 접속 아이피 |
| world_no | String | N | - | 1 | 게임 월드 번호 |
| character_no | String | N | - | 52345642 | 회원 캐릭 번호 |
| game_coupon_id | Int64 | N | - | 15451 | 게임쿠폰아이디 (있는 경우, 해당 게임쿠폰아이디 값과 맞지 않으면 잘못된 쿠폰번호로 처리) |
| lang_code | String | Y | - | ko | 언어코드 |
# Response
# Body
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| result | String | Y | - | 000 | 응답 코드 |
| message | String | Y | - | OK | 응답 메시지 |
| value | Object | N | - | - | 응답 값 |
# value
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| coupon_box_id | Int64 | Y | - | 6449393 | 쿠폰박스 일련번호 |
| cbox_save_flag | Boolean | Y | - | ture | 쿠폰함 저장 여부 |
# Sample
# Request
curl --location --request POST '/coupon/v3.0/web/game/coupon/use' \
--header 'Authorization: Bearer {{access_token}}'
{
"game_code":"STOVE_QA_ALPHA",
"coupon_no":"AMH0G4E0A110VBM8",
"client_ipaddr":"211.34.57.2",
"world_no":"1",
"character_no":"98175593",
"lang_code":"ko"
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# Response
{
"value":
{
"coupon_box_id":4010326,
"cbox_save_flag":false
},
"result": "000",
"message": "OK"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
응답 실패 예제
{
"result": "5105",
"message": "잘못된 쿠폰 번호입니다. 쿠폰 번호를 확인해주시기 바랍니다. (1회 실패)"
}
1
2
3
4
2
3
4
# Return Code
| HTTP Status code | Code | Message | Description |
|---|---|---|---|
| 200 | 5031 | 일일 인증 횟수를 초과하였습니다. | |
| 200 | 5105 | 잘못된 쿠폰 번호입니다. 쿠폰 번호를 확인해주시기 바랍니다. | 잘못된 쿠폰 번호입니다. ({0}회 실패) 쿠폰 번호를 확인해주시기 바랍니다. - 실제 나가는 에러 메세지 |
| 200 | 5165 | 쿠폰함에서만 사용 가능한 쿠폰 입니다. | 해당 쿠폰 번호가 계정지급쿠폰의 쿠폰번호 인 경우 |
| 200 | 5450 | 이미 쿠폰함에 등록된 쿠폰입니다. | 쿠폰번호를 최대 1번 사용 가능하고 이미 쿠폰함에 등록되어 있는 쿠폰번호 인 경우 |
| 200 | 5125 | 이미 사용한 쿠폰입니다. | |
| 200 | 5130 | 사용 중지된 쿠폰입니다. | 파트너스나 게임이용동의 해지로 폐기된 쿠폰인 경우 |
| 200 | 5135 | 유효기간이 만료된 쿠폰입니다. | 쿠폰사용기간이 지남 |
| 200 | 5161 | 등록 기간이 만료된 쿠폰입니다. | 쿠폰등록기간이 지남 |
| 200 | 6055 | 등록기간이 아닙니다.(등록기간이 되지 않았음) | |
| 200 | 5162 | 해당 국가에서 사용할 수 없는 쿠폰입니다. | |
| 200 | 2605 | 해당 멤버쉽 계정은 사용할 수 없습니다. | |
| 200 | 5202 | 이미 해당 그룹 쿠폰을 사용하셨습니다. | 그룹쿠폰 |
| 200 | 5033 | 해당 쿠폰번호를 더 이상 사용하실 수 없습니다. | 하나의 쿠폰키로 여러번 사용가능한 경우(대표쿠폰,그룹쿠폰 해당됨) |
| 200 | 5155 | 해당 쿠폰의 사용가능 횟수를 초과 하였습니다. | |
| 200 | 5200 | 해당 쿠폰에 대한 사용 대상이 아닙니다. | 대상지정쿠폰-해당 계정이 아닌 경우 |
| 200 | 6033 | 해당 그룹의 쿠폰을 이미 사용하였습니다. | 쿠폰 그룹핑 그룹핑된 다른 쿠폰을 사용한 경우 |
| 200 | 6026 | 사용 횟수가 초과 되었습니다. | 24시간 제한 |
| 200 | 100 | PC방에서만 사용 가능한 쿠폰입니다. | 이전메세지(PC방 전용 쿠폰.) |
| 200 | 7014 | 캐릭터를 선택해 주세요. | 등록 즉시 사용 쿠폰이면서, 캐릭터정보가 필요한 경우 |
| 200 | 5164 | 해당 월드에서는 사용할 수 없는 쿠폰입니다. | |
| 200 | 그 외 | [Internal Error] | 내부오류: *STOVE 기술PM팀으로 문의 바랍니다. |
| 401 | 999 | Authorization has been denied for this request |