# 통합 쿠폰함 쿠폰 사용 API
# 소개
쿠폰함 쿠폰을 사용합니다.
# 기본정보
POST /coupon/v3.0/{user_token_type}/couponbox/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_ID | 게임ID (플랫폼에서 부여) |
| coupon_box_id | Int64 | Y | - | 10169 | 쿠폰박스 일련번호 |
| world_no | String | N | - | 1 | 게임 월드 번호 |
| character_no | String | N | - | 52345642 | 회원 캐릭 번호 |
| client_ipaddr | String | Y | - | 10.5.24.52 | 회원 접속 아이피 |
| lang_code | String | Y | - | ko | 언어코드 |
# Response
# Body
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| result | String | Y | - | 000 | 응답 코드 |
| message | String | Y | - | OK | 응답 메시지 |
| value | Boolean | Y | - | true | 응답 값 |
# Sample
# Request
curl --location --request POST 'https://api.onstove.com/coupon/v3.0/web/couponbox/use' \
--header 'Authorization: Bearer {{access_token}}'
{
"lang_code": "KO",
"game_code" : "STOVE_ID",
"coupon_box_id":3,
"world_no":"world1",
"character_no":"456",
"client_ipaddr": "127.0.0.1"
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# Response
응답 성공 예제
{
"value": true,
"result": "000",
"message": "OK"
}
1
2
3
4
5
2
3
4
5
응답 실패 예제
{
"result": "5105",
"message": "잘못된 쿠폰 번호입니다. 쿠폰 번호를 확인해주시기 바랍니다. (1회 실패)"
}
1
2
3
4
2
3
4
# Return Code
| HTTP Status code | Code | Message | Description |
|---|---|---|---|
| 200 | 999 | unexpected error | 시스템오류 |
| 401 | 999 | Authorization has been denied for this request | |
| 401 | 40101 | invalid token | 토큰 복호화가 안되는 경우 |
| 401 | 40102 | invalid token | 복호화 했으나 포맷이 다른 경우 |
| 401 | 40103 | expired token | 토큰이 만료된 경우 |
| 401 | 40104 | expired token | 관리자의 무효처리에 의해 토큰이 만료된 경우 |
| 500 | 50000 | internal error | 장애 상황(DB 연결 불가 등) |
| 200 | 6007 | 해당 쿠폰을 찾을 수 없습니다.(없는 쿠폰박스 ID 입니다.) | - |
| 200 | 6008 | 해당 유저가 가지고 있는 쿠폰이 아닙니다. | - |
| 200 | 6009 | 쿠폰을 사용 가능한 날짜가 아닙니다. | - |
| 200 | 6032 | 쿠폰 사용 가능한 횟수가 초과되었습니다. | - |
| 200 | 7014 | 캐릭터를 선택해 주세요. | 캐릭터 선택이 필요한 쿠폰인 경우 |
| 200 | 6010 | 해당 월드에서 사용할 수 없는 쿠폰 입니다. | - |
| 200 | 5162 | 해당 국가에서 사용할 수 없는 쿠폰 입니다. | - |
| 200 | 그 외 | [Internal Error] | 내부오류: *STOVE 기술PM팀으로 문의 바랍니다. |