Skip to content

랭킹 정산 API draft

Justin edited this page Dec 1, 2013 · 12 revisions

랭킹 정산 API

리셋된 점수들에 대해서, 보상이 걸려 있는 경우 지급한다.

  • Path: /:version/leaderboards/prize/:leaderboard_id
  • Authentication Header: X-APP-KEY, X-AUTH-UUID, X-AUTH-TOKEN
  • Method: POST
  • Request Parameter: JSON
Name Type Description
leaderboard_id String leaderboard의 id
* Request Body: 없음
  • Response Body: JSON
Name Type Description
result_code Number Error Code 참고
result_message Option[String] 실패한 경우에 메시지 있을 수 있음
prized Option[JSON Object] 새롭게 정산이 된 경우에 있음
Name Type Description
season_from String 정산을 한 기간의 시작. 시간 형식은 "yyyy-MM-dd'T'HH:mm:ss"
season_to String 정산을 한 기간의 끝. 시간 형식은 "yyyy-MM-dd'T'HH:mm:ss"
score Number 나의 score 값
rank Number 나의 등수
scores_count Number 전체 scores 목록의 개수
top_scores JSON Array 상위 score 정보 3등까지만
Name Type Description
value Number 점수
rank Number 등수. 1부터 시작
platform_user_id String 카카오 user_id
rewards JSON Array 보상이 지급된 경우 보상들 다음 json 객체의 array가 포함됨
Name Type Description
id Number 보상의 id
mail_id Number 메일의 id
changes JSON Array Reward 아이템 조회 API 참고
prized_at String 정산한 시간. 시간 형식은 "yyyy-MM-dd'T'HH:mm:ss"
  • Response Sample:
{
    "result_code": 0,
    "prized": {
        "season_from": "2013-10-06T00:00:00",
        "season_to": "2013-10-13T00:00:00",
        "prized_at": "2013-10-13T00:00:00",
        "score": 123,
        "rank": 109,
        "top_scores": [
            {
                "platform_user_id": "user_id_99",
                "value": 17524,
                "rank": 1
            },
            {
                "platform_user_id": "user_id_98",
                "value": 17523,
                "rank": 2
            },
            {
                "platform_user_id": "user_id_20",
                "value": 12001,
                "rank": 3
            }
        ],
        "scores_count": 120,
        "rewards": [
            {
                "id": 12314324,
                "mail_id": 48382,
                "changes": [
                    {
                        "key": "item1",
                        "command": "inc",
                        "value": 100
                    },
                    {
                        "key": "item2",
                        "command": "set",
                        "value": 1
                    }
                ]
            },
            {
                "id": 2312341,
                "mail_id": 1148382,
                "changes": [
                    {
                        "key": "char1",
                        "command": "set",
                        "value": 1
                    }
                ]
            }
        ]
    }
}

Clone this wiki locally