排名板登录API

Request

---

• Method : POST

• URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards

POST
url : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards
Header : 'content-type: application/json'
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
data:
{
    "id" : "leaderboardId",
    "status": true,
    "name": "name",
    "description": "description",
    "iconUrl" : "icon_url",
    "descending": true,
    "startedAt" : "2023-01-22 13:00:00",
    "timezone" : "Asia/Seoul",
    "periodType" : "weekly",
    "resetDay": 1,
    "resetDate": 1,
    "resetTime" : "00:01:01",
    "ranking" : "latest", 
    "tie_breaking" : "first"
}

Header	Type	Required	Description
X-API-KEY	String	O	GamePot发放的认证密钥
X-PROJECT-ID	String	O	仪表盘项目ID

Attribute	Type	Required	Description
id	String	O	排名板固有ID
projectId	String	O	项目ID
status	Boolean	O	状态
is_check_user	Boolean	-	是否检查用户ID
name	String	-	排名板名称
description	String	-	说明
iconUrl	String	-	图标URL
descending	Boolean	-	排序
startedAt	String	-	开始日期
expiredAt	String	-	结束日期（season的情况）
timezone	String	-	时区
period_type	String	-	周期(daily、weekly、monthly、season)
resetDay	Integer	-	初始化日期 1：星期日、2.星期一、3.星期二、4.星期三、5.星期四、6.星期五、7.星期六（periodType为weekly时）
resetTime	String	-	初始化时间
resetDate	Integer	-	初始化日期1~31（periodType为monthly时）
ranking	String	O	排名更新标准(latest、accumulated、best)
tie_breaking	String	O	同分者处理标准(first、last)

Response

---

成功

{
   "leaderboard": {
        "status": true,
        "is_check_user": true,
        "ranking": "latest",
        "tie_breaking": "first",
        "id": "TGVhZGVyYm9hcmQ6ZHNzZGFkMTIyMjIyMTJhZA==",
        "name": "name",
        "description": "description",
        "descending": true,
        "resetDay": 1,
        "resetTime": "00:01:01",
        "resetDate": 1,
        "startedAt": "2023-01-22T13:00:00-08:00",
        "expiredAt": "2023-11-22T13:00:00-08:00",
        "timezone": "Asia/Seoul",
        "project_id": "ec8231b2-6b20-4ad1-9c59-8e183087a742",
        "period_type": "weekly",
        "icon_url": "icon_url",
        "user_count": null,
        "updatedAt": "2023-02-01T15:52:24-08:00",
        "createdAt": "2023-02-01T15:52:24-08:00"
    }
}

Attribute	Type	Required	Description
id	String	O	排名板固有ID
projectId	String	O	项目ID
status	Boolean	O	状态
is_check_user	Boolean	-	是否检查用户ID
name	String	-	排名板名称
description	String	-	说明
icon_url	String	-	图标URL
descending	Boolean	-	排序
startedAt	String	-	开始日期
expiredAt	String	-	结束日期（season的情况）
timezone	String	-	时区
period_type	String	-	周期(daily、weekly、monthly、season)
resetDay	Integer	-	初始化日期 1：星期日、2.星期一、3.星期二、4.星期三、5.星期四、6.星期五、7.星期六（periodType为weekly时）
resetTime	String	-	初始化时间
resetDate	Integer	-	初始化日期1~31（periodType为monthly时）
ranking	String	O	排名更新标准(latest、accumulated、best)
tie_breaking	String	O	同分者处理标准(first、last)

失败

 "status": -1,
"message": "错误消息"

Attribute	Type	Description
code	Int	结果值（1：成功，失败时请参考Error code）
error	String	错误内容