การแลกคูปองเว็บ
URL เซิร์ฟเวอร์¶
URL ทั่วไป | https://coupon.withhive.com |
---|---|
URL Sandbox | https://sandbox-coupon.withhive.com |
เซิร์ฟเวอร์คูปอง IP¶
คำอธิบาย | โปรดตรวจสอบให้แน่ใจว่าได้ยกเลิกการใช้กฎไฟร์วอลล์ขาเข้าของ IP ด้านล่างจากเซิร์ฟเวอร์เกมแล้ว. |
---|---|
IP ทั่วไป | 13.124.83.83, 52.78.11.220, 3.34.204.168, 3.35.59.227, 43.202.201.239, 43.200.188.52 |
IP แซนด์บ็อกซ์ | 43.155.155.10 |
API การใช้คูปอง¶
พื้นฐาน¶
คำอธิบาย | กระบวนการใช้คูปองที่ออกและส่งสินค้า | |||
คู่มืออ้างอิง | นโยบายตัวระบุ | |||
URL | /tp/coupon/api | |||
วิธีการ | POST | รูปแบบการตอบกลับ | JSON | |
HTTP Header | ประเภทเนื้อหา | application/json | เปอร์เซ็นต์ ของการเรียก | |
การอนุญาต | Bearer Token (AppCenter Token) |
พารามิเตอร์การร้องขอ¶
ชื่อฟิลด์ | ประเภท | จำเป็น (บังคับ: M, ตัวเลือก: O) | คำอธิบาย |
---|---|---|---|
game_index | จำนวนเต็ม | M | ดัชนีเกม AppCenter |
coupon | สตริง | M | หมายเลขคูปอง |
cs_code | สตริง | M | รหัส CS ของผู้ใช้ในเกม |
server_id | สตริง | M | ID เซิร์ฟเวอร์เกมสำหรับการส่งรายการ (เช่น KR) |
language | สตริง | O | รหัสภาษาของข้อความตอบกลับ (ค่าเริ่มต้น: อังกฤษ) (ดูรหัสภาษาในคู่มืออ้างอิง) ใช้ในการแสดงข้อความบนหน้าจอเกมตามที่เป็นอยู่ |
additionalinfo | สตริง | O | ข้อมูลเพิ่มเติมสำหรับส่งไปยังเซิร์ฟเวอร์เกม (ส่งในรูปแบบ JSON String) |
องค์ประกอบการตอบกลับ¶
ชื่อฟิลด์ | ประเภท | จำเป็น (บังคับ: M, ตัวเลือก: O) | คำอธิบาย |
---|---|---|---|
code | จำนวนเต็ม | Y | รหัสการตอบกลับ (100: สำเร็จ) |
message | สตริง | Y | ข้อความผลลัพธ์ตามรหัสการตอบกลับ |
- ตัวอย่างการโทร
curl -L -v
-d '{"game_index":539,"coupon":"HIVESDKTEST","cs_code":"123456789","server_id":"KR","additionalinfo":"{"user_level":50,"chanel":1,"sub_sever":"1"}"}'
-H "Content-Type: text/html"
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAzNzc4OTU2LCJqdGkiOiIxODczMTExMzIwIn0.OxWo4R6UdI0BLP1ckt8RlMFrPAb5H7TNedmLFV1Cawc"
https://sandbox-coupon.withhive.com/tp/coupon/api
- ตัวอย่างคำขอ
>> POST /tp/coupon/api HTTP/2
> Host: sandbox-coupon.withhive.com
> user-agent: curl/7.68.0
> Content-Type: application/json
> Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAzNzc4OTU2LCJqdGkiOiIxODczMTExMzIwIn0.OxWo4R6UdI0BLP1ckt8RlMFrPAb5H7TNedmLFV1Cawc
> Accept: */*
> Content-Length: 163
- ตัวอย่างการตอบกลับ
< HTTP/2 200
< server: nginx
< date: Wed, 23 Mar 2022 09:49:29 GMT
< content-type: application/json; charset=utf-8
{"code":100,"message":"The Coupon Code has been redeemed."}
รหัสตอบกลับ (เซิร์ฟเวอร์ API)¶
รหัส | คำอธิบาย | ข้อความ |
---|---|---|
100 | สำเร็จ | รหัสคูปองถูกแลกแล้ว |
200 | ข้อผิดพลาดพารามิเตอร์ที่ร้องขอ | ไม่มีพารามิเตอร์ หรือชื่อพารามิเตอร์ไม่ถูกต้อง |
202 | เกินขีดจำกัดการใช้งานสำหรับบัญชี | จำนวนคูปองที่ถูกต้องเกินขีดจำกัด |
203 | จำนวนคูปองกลุ่มที่มีอยู่เกิน | จำนวนคูปองที่ถูกต้องเกินขีดจำกัด! |
204 | ไม่ตรงกับข้อมูลเกมและคูปองที่ออก | ใช้ได้เฉพาะที่การแลกคูปองในงานของเกมที่เกี่ยวข้อง |
302 | คูปองไม่มีอยู่ | รหัสคูปองไม่มีอยู่ กรุณาตรวจสอบอีกครั้ง |
303 | คูปองกำลังใช้งาน | คูปองถูกใช้งานแล้ว |
304 | คูปองที่ใช้แล้ว | คูปองถูกใช้งานแล้ว |
305 | เกินขีดจำกัดการใช้งานสำหรับคูปอง (คูปองเฉพาะหมดอายุจำนวนที่ใช้ได้) | คูปองทั้งหมดที่ออกมีการใช้งานแล้ว |
306 | คูปองหมดอายุ | คูปองหมดอายุแล้ว |
311 | คูปองที่ถูกยกเลิก | คูปองถูกยกเลิกแล้ว |
312 | ก่อนช่วงเวลาคูปอง | คูปองยังไม่สามารถใช้งานได้ (ยกเว้นคูปองทดสอบ) |
400 | ไม่สามารถส่งรายการทั้งหมดได้ | ไม่สามารถแลกคูปองได้ กรุณาติดต่อฝ่ายสนับสนุนลูกค้าของเราหากปัญหายังคงอยู่ |
401 | ไม่สามารถส่งหลายรายการได้ | ไม่สามารถแลกคูปองบางส่วนได้ กรุณาติดต่อฝ่ายสนับสนุนลูกค้าของเรา |
500 | ข้อผิดพลาดในการสื่อสารฐานข้อมูล | ไม่สามารถแลกคูปองได้ กรุณาติดต่อฝ่ายสนับสนุนลูกค้าของเราหากปัญหายังคงอยู่ |
501 | ข้อผิดพลาดในการสื่อสารเซิร์ฟเวอร์ | ไม่สามารถแลกคูปองได้ กรุณาติดต่อฝ่ายสนับสนุนลูกค้าของเราหากปัญหายังคงอยู่ |
ข้อตกลง API ในการตรวจสอบผู้ใช้และค้นหารายชื่อเซิร์ฟเวอร์เกม¶
กำหนดโปรโตคอลสำหรับการตรวจสอบความถูกต้องของผู้ใช้และการดึงรายการเซิร์ฟเวอร์เกม เพื่อทำเช่นนี้ เซิร์ฟเวอร์เกมควรปิดการตั้งค่ากฎไฟร์วอลล์ที่เข้ามาต่อ IP เซิร์ฟเวอร์คูปอง เพื่อเปิดใช้งานการสื่อสาร API ระหว่างเซิร์ฟเวอร์เกมและเซิร์ฟเวอร์คูปอง
พื้นฐาน¶
คำอธิบาย | กำหนดข้อตกลง API ในการตรวจสอบผู้ใช้จากเซิร์ฟเวอร์เกมและค้นหารายการเซิร์ฟเวอร์เกมที่สามารถใช้คูปองได้ | |||
URL | Hive Console > Billing > Coupon > Web Coupon Exchange Settings > Settings > Register Game Server API | |||
วิธีการ | POST | รูปแบบการตอบกลับ | JSON | |
HTTP Header | Content-type | application/json | เปอร์เซ็นต์ของการเรียก |
พารามิเตอร์การร้องขอ (เซิร์ฟเวอร์คูปองไปยังเซิร์ฟเวอร์เกม)¶
ชื่อฟิลด์ | ประเภท | จำเป็น (บังคับ: M, ตัวเลือก: O) | คำอธิบาย |
cs_code | String | M | CS CODE ของผู้ใช้ |
server | Array | O | รายการเซิร์ฟเวอร์เกมที่เปิดใช้งาน ตัวเลือกการแลกคูปองเว็บ ในเมนูการจัดการรายการสินค้า ไปที่ Hive Console > billing > Coupon > Web Coupon Exchange Settings > เลือกแอปของคุณ ค้นหา และ คลิก การตั้งค่า > รายการ ของเซิร์ฟเวอร์ในข้อมูลเซิร์ฟเวอร์ที่มี URL API ที่ถูกต้องและการเปิดเผยเซิร์ฟเวอร์เป็น "ON" |
องค์ประกอบการตอบสนอง (เซิร์ฟเวอร์เกมไปยังเซิร์ฟเวอร์คูปอง)¶
ชื่อฟิลด์ | ประเภท | จำเป็น (บังคับ: M, ตัวเลือก: O) | คำอธิบาย |
---|---|---|---|
code | จำนวนเต็ม | M | รหัสการตอบกลับ (100: OK) |
message | สตริง | M | ข้อความผลลัพธ์ตามรหัสการตอบกลับ |
data | อ็อบเจ็กต์ | M | ข้อมูลการตอบกลับ (แต่จะส่งคืนเฉพาะในกรณีที่ตอบกลับสำเร็จเท่านั้น ไม่มีการตอบกลับเมื่อเกิดข้อผิดพลาด) |
┕ default_lang | สตริง | M | ภาษาในการตั้งค่าเริ่มต้น (แสดงหากไม่มีการตั้งค่าภาษา) |
┕ extra_display | จำนวนเต็ม | O | แสดงค่าของ additionalinfo เพิ่มเติมหลังจากชื่อเซิร์ฟเวอร์ที่แสดงในรายการเซิร์ฟเวอร์แลกคูปอง (※ ไม่แสดงเมื่อไม่มีการระบุค่า extra_display ) (แสดงและแยกค่าด้วยขีดกลางเฉพาะในค่าของ JSON)
ASIA ค่าตัวแรก หากส่งคืน 1 .) |
┕ server_list | อาร์เรย์ | M | รายการเซิร์ฟเวอร์ |
┕ server_id | สตริง | M | รหัสเซิร์ฟเวอร์เกมที่ส่งมอบรายการ (เช่น KR) |
┕ server_display_names | อ็อบเจ็กต์ | M | ชื่อเซิร์ฟเวอร์หลายภาษา ที่แสดงในรายการเซิร์ฟเวอร์แลกคูปอง (※ ต้องการภาษาที่ตั้งค่าเริ่มต้นและภาษาที่แสดง) |
┕ ko ~ ar | สตริง | O |
|
┕ additionalinfo | อ็อบเจ็กต์ | O | ค่าพิเศษที่ส่งไปยังเซิร์ฟเวอร์เกมสำหรับการร้องขอการส่งมอบรายการ |
- ตัวอย่างคำขอ
// ※ The "additionalinfo" value below is a sample. You can send a required value to a game server additionally.
// ※ "server_display_name" is a server name displayed to users, and "server_id" is exposed when making a request to a game server.
{
"code": 100,
"message": "Success",
"data": {
"default_lang": "en",
"extra_display": 0,
"server_list": [
{
"server_id": "KR",
"server_display_names": {
"ko": "한국서버",
"en": "Korea Server",
"ja": "韓国サーバー",
"zh-hans": "韓國服務器",
"zh-hant": "韩国服务器",
"de": "Koreanischer Server",
"fr": "Serveur coréen",
"ru": "Корейский сервер",
"es": "servidor coreano",
"pt": "servidor coreano",
"id": "server korea",
"th": "เซิฟเวอร์เกาหลี",
"vi": "Máy chủ hàn quốc",
"it": "Server coreano",
"tr": "Kore sunucusu",
"ar": "الخادم الكوري"
},
"additionalinfo": {
"region": "ASIA",
"user_detail": {
"level": 50,
"tier": "PLATINUM",
"nickname": "USER",
"gold": "0",
"gem": "0"
}
}
},
......
]
}
}
// When an error occurs because of a wrong parameter
{
"code": 200,
"message": "No parameter, or invalid parameter name."
}
// Invalid user data (CS_CODE)
{
"code": 201,
"message": "No data, or invalid cs_code."
}
ข้อตกลง API เกี่ยวกับการตรวจสอบคูปองผู้สร้าง¶
พื้นฐาน¶
คำอธิบาย | กำหนดข้อตกลง API ในการตรวจสอบคูปองของผู้สร้างจากเซิร์ฟเวอร์เกมหรือเซิร์ฟเวอร์ของผู้สร้าง | |||
URL | Hive Console > Billing > Coupon > Web Coupon Exchange Settings > Settings > Register Creator API | |||
วิธีการ | POST | รูปแบบการตอบกลับ | JSON | |
HTTP Header | Content-type | application/json |
พารามิเตอร์การร้องขอ (จากเซิร์ฟเวอร์คูปองไปยังเซิร์ฟเวอร์ผู้สร้าง (เกม))¶
ชื่อฟิลด์ | ประเภท | จำเป็น (บังคับ: M, ตัวเลือก: O) | คำอธิบาย |
---|---|---|---|
cs_code | สตริง | M | รหัส CS ของผู้ใช้ |
coupon_code | สตริง | M | หมายเลขคูปอง |
additionalinfo | อ็อบเจ็กต์ | O | ข้อมูลเพิ่มเติมที่ส่งไปยังเซิร์ฟเวอร์ผู้สร้างหรือเซิร์ฟเวอร์เกม |
องค์ประกอบการตอบกลับ (เซิร์ฟเวอร์ผู้สร้าง (เกม) ไปยังเซิร์ฟเวอร์คูปอง)¶
ชื่อฟิลด์ | ประเภท | จำเป็น (บังคับ: M, ตัวเลือก: O) | คำอธิบาย |
---|---|---|---|
code | จำนวนเต็ม | M | รหัสการตอบกลับ (100: OK) |
message | สตริง | M | ข้อความผลลัพธ์ตามรหัสการตอบกลับ |
- ตัวอย่างคำขอ
- ตัวอย่างการตอบกลับ
// Success
{
"code":100, "message": "Success"
}
// invoking an error becase of invalid parameters
{
"code":200, "message": "No parameter, or invalid parameter name."
}
// when the coupon received from a creator is invalid
{
"code":201, "message": "No data, or invalid creator."
}
- (หน้าจอ PC) เมื่อคูปองไม่พร้อมใช้งาน