리더보드 API
리더보드 이용자 스코어 등록 API
Request
- Method : POST
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | 대시보드에서 생성한 리더보드 고유ID |
userId | String | O | 사용자ID |
score | Integer | X | 점수 |
subscore | Integer | X | 서브 점수(필수 아님) |
metadata | String | X | 추가 정보 |
Response
성공
Attribute | Type | Description |
---|
status | Int | 결과 값 (-1 실패) |
message | String | 오류 메시지 |
leaderboardlog.project_id | String | 프로젝트ID |
leaderboardlog.id | String | 입력ID |
leaderboardlog.user_id | String | 사용자ID |
leaderboardlog.score | Int | 점수 |
leaderboardlog.subscore | Int | 서브 점수 |
leaderboardlog.metadata | Int | 사용자 정의 데이터 |
leaderboardlog.expiredAt | String | 만료날짜 |
실패
Attribute | Type | Description |
---|
code | Int | 결과 값 (1: 성공, 실패 시 Error code 참고) |
error | String | 오류 내용 |
리더보드 사용자 스코어 가져오기 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | 대시보드에서 생성한 리더보드 고유ID |
offset | Integer | X | OFFSET |
per_page | Integer | X | LIMIT |
Response
성공
Attribute | Type | Description |
---|
status | Int | 결과 값 (-1 실패) |
message | String | 오류 메시지 |
rank | Int | 순위 |
project_id | String | 프로젝트ID |
leaderboardId | String | 대시보드에서 생성한 리더보드 고유ID |
user_id | String | 사용자ID |
score | Int | 점수 |
subscore | Int | 서브 점수 |
metadata | Int | 사용자 정의 데이터 |
updatedAt | String | 업데이트일 |
expiredAt | String | 만료일 |
실패
Attribute | Type | Description |
---|
status | Int | 결과값 (실패 시 Error code 참고) |
message | String | 오류 내용 |
특정 검색어를 이용한 점수 가져오기 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
ID 를 통한 검색 방법
SCORE 범위를 통한 검색 방법
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | 대시보드에서 생성한 리더보드 고유ID |
offset | Integer | X | OFFSET |
per_page | Integer | X | LIMIT |
Response
성공
실패
Attribute | Type | Description |
---|
status | Int | 결과 값 (실패 시 Error code 참고) |
message | String | 오류 내용 |
리더보드 정보 및 이용자수 가져오기 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards?/{leaderboardId}?offset=0&per_page=10
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | 대시보드에서 생성한 리더보드 고유ID |
offset | Integer | X | OFFSET |
per_page | Integer | X | LIMIT |
Response
성공
Attribute | Type | Required | Description |
---|
id | String | O | 리더보드 고유ID |
projectId | String | O | 프로젝트ID |
status | Boolean | O | 상태 |
is_check_user | Boolean | X | 사용자ID 체크 여부 |
name | String | X | 리더보드 이름 |
description | String | X | 설명 |
icon_url | String | X | 아이콘 URL |
descending | Boolean | X | 정렬 |
startedAt | String | X | 시작일 |
expiredAt | String | X | 종료일 (season 일 경우) |
timezone | String | X | 타임존 |
period_type | String | X | 주기 ( daily, weekly, monthly, season) |
resetDay | Integer | X | 초기화 요일 1: 일요일 , 2. 월요일 , 3.화요일 , 4.수요일 , 5.목요일 , 6.금요일 , 7.토요일 (periodType가 weekly 일때) |
resetTime | String | X | 초기화 시간 |
resetDate | Integer | X | 초기화 날짜 1~31 (periodType가 monthly 일때) |
ranking | String | O | 랭킹 업데이트 기준 ( latest, accumulated, best ) |
tie_breaking | String | O | 동점자 처리 기준 ( first, last) |
실패
Attribute | Type | Description |
---|
status | Int | 결과값 (실패 시 Error code 참고) |
message | String | 오류 내용 |
리더보드에서 사용자 점수 조회 API
Request
- Method : GET
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboard/{leaderboardID}/user{userid}
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardID | String | O | 대시보드에서 생성한 리더보드 고유ID |
userid | String | O | 사용자ID |
Response
성공
Attribute | Type | Description |
---|
status | Int | 결과 값 (-1 실패) |
message | String | 오류 메시지 |
rank | Int | 순위 |
project_id | String | 프로젝트ID |
leaderboardId | String | 대시보드에서 생성한 리더보드 고유ID |
user_id | String | 사용자ID |
score | Int | 점수 |
subscore | Int | 서브 점수 |
metadata | Int | 사용자 정의 데이터 |
updatedAt | String | 업데이트일 |
expiredAt | String | 만료일 |
실패
Attribute | Type | Description |
---|
status | Int | 결과값 (실패 시 Error code 참고) |
message | String | 오류 내용 |
리더보드 등록 이용자 삭제 API
Request
- Method : DELETE
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboardlogs
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardId | String | X | 리더보드ID |
userId | String | X | 리더보드 사용자 ID |
Response
성공
Attribute | Type | Description |
---|
status | Int | 결과 값 (-1 실패) |
message | String | 오류 메시지 |
project_id | String | 프로젝트ID |
leaderboardId | String | 대시보드에서 생성한 리더보드 고유ID |
user_id | String | 사용자ID |
score | Int | 점수 |
subscore | Int | 서브 점수 |
metadata | Int | 사용자 정의 데이터 |
updatedAt | String | 업데이트일 |
expiredAt | String | 만료일 |
실패
Attribute | Type | Description |
---|
status | Int | 결과값 (실패 시 Error code 참고) |
message | String | 오류 내용 |
리더보드 등록 API
Request
- Method : POST
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
id | String | O | 리더보드 고유ID |
projectId | String | O | 프로젝트ID |
status | Boolean | O | 상태 |
is_check_user | Boolean | X | 사용자ID 체크 여부 |
name | String | X | 리더보드 이름 |
description | String | X | 설명 |
iconUrl | String | X | 아이콘 URL |
descending | Boolean | X | 정렬 |
startedAt | String | X | 시작일 |
expiredAt | String | X | 종료일 (season 일 경우) |
timezone | String | X | 타임존 |
period_type | String | X | 주기 ( daily, weekly, monthly, season) |
resetDay | Integer | X | 초기화 요일 1: 일요일 , 2. 월요일 , 3.화요일 , 4.수요일 , 5.목요일 , 6.금요일 , 7.토요일 (periodType가 weekly 일때) |
resetTime | String | X | 초기화 시간 |
resetDate | Integer | X | 초기화 날짜 1~31 (periodType가 monthly 일때) |
ranking | String | O | 랭킹 업데이트 기준 ( latest, accumulated, best ) |
tie_breaking | String | O | 동점자 처리 기준 ( first, last) |
Response
성공
Attribute | Type | Required | Description |
---|
id | String | O | 리더보드 고유ID |
projectId | String | O | 프로젝트ID |
status | Boolean | O | 상태 |
is_check_user | Boolean | X | 사용자ID 체크 여부 |
name | String | X | 리더보드 이름 |
description | String | X | 설명 |
icon_url | String | X | 아이콘 URL |
descending | Boolean | X | 정렬 |
startedAt | String | X | 시작일 |
expiredAt | String | X | 종료일 (season 일 경우) |
timezone | String | X | 타임존 |
period_type | String | X | 주기 ( daily, weekly, monthly, season) |
resetDay | Integer | X | 초기화 요일 1: 일요일 , 2. 월요일 , 3.화요일 , 4.수요일 , 5.목요일 , 6.금요일 , 7.토요일 (periodType가 weekly 일때) |
resetTime | String | X | 초기화 시간 |
resetDate | Integer | X | 초기화 날짜 1~31 (periodType가 monthly 일때) |
ranking | String | O | 랭킹 업데이트 기준 ( latest, accumulated, best ) |
tie_breaking | String | O | 동점자 처리 기준 ( first, last) |
실패
Attribute | Type | Description |
---|
code | Int | 결과 값 (1: 성공, 실패 시 Error code 참고) |
error | String | 오류 내용 |
리더보드 수정 API
Request
- Method : PUT
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards/{leaderboardId}
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | 리더보드 고유ID |
status | Boolean | O | 상태 |
is_check_user | Boolean | X | 사용자ID 체크 여부 |
name | String | X | 리더보드 이름 |
description | String | X | 설명 |
icon_url | String | X | 아이콘 URL |
descending | Boolean | X | 정렬 |
startedAt | String | X | 시작일 |
expiredAt | String | X | 종료일 (season 일 경우) |
timezone | String | X | 타임존 |
period_type | String | X | 주기 ( daily, weekly, monthly, season) |
resetDay | Integer | X | 초기화 요일 1: 일요일 , 2. 월요일 , 3.화요일 , 4.수요일 , 5.목요일 , 6.금요일 , 7.토요일 (periodType가 weekly 일때) |
resetTime | String | X | 초기화 시간 |
resetDate | Integer | X | 초기화 날짜 1~31 (periodType가 monthly 일때) |
ranking | String | O | 랭킹 업데이트 기준 ( latest, accumulated, best ) |
tie_breaking | String | O | 동점자 처리 기준 ( first, last) |
Response
성공
Attribute | Type | Required | Description |
---|
id | String | O | 리더보드 고유ID |
projectId | String | O | 프로젝트ID |
status | Boolean | O | 상태 |
is_check_user | Boolean | X | 사용자ID 체크 여부 |
name | String | X | 리더보드 이름 |
description | String | X | 설명 |
icon_url | String | X | 아이콘 URL |
descending | Boolean | X | 정렬 |
startedAt | String | X | 시작일 |
expiredAt | String | X | 종료일 (season 일 경우) |
timezone | String | X | 타임존 |
period_type | String | X | 주기 ( daily, weekly, monthly, season) |
resetDay | Integer | X | 초기화 요일 1: 일요일 , 2. 월요일 , 3.화요일 , 4.수요일 , 5.목요일 , 6.금요일 , 7.토요일 (periodType가 weekly 일때) |
resetTime | String | X | 초기화 시간 |
resetDate | Integer | X | 초기화 날짜 1~31 (periodType가 monthly 일때) |
ranking | String | O | 랭킹 업데이트 기준 ( latest, accumulated, best ) |
tie_breaking | String | O | 동점자 처리 기준 ( first, last) |
실패
Attribute | Type | Description |
---|
code | Int | 결과 값 (1: 성공, 실패 시 Error code 참고) |
error | String | 오류 내용 |
리더보드 삭제 API
Request
- Method : DELETE
- URI : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboards/{leaderboardId}
Header | Type | Required | Description |
---|
X-API-KEY | String | O | GamePot에서 발급하는 인증 키 |
X-PROJECT-ID | String | O | 대시보드 프로젝트 아이디 |
Attribute | Type | Required | Description |
---|
leaderboardId | String | O | 리더보드 고유ID |
Response
성공
성공
Attribute | Type | Required | Description |
---|
id | String | O | 리더보드 고유ID |
projectId | String | O | 프로젝트ID |
status | Boolean | O | 상태 |
is_check_user | Boolean | X | 사용자ID 체크 여부 |
name | String | X | 리더보드 이름 |
description | String | X | 설명 |
icon_url | String | X | 아이콘 URL |
descending | Boolean | X | 정렬 |
startedAt | String | X | 시작일 |
expiredAt | String | X | 종료일 (season 일 경우) |
timezone | String | X | 타임존 |
period_type | String | X | 주기 ( daily, weekly, monthly, season) |
resetDay | Integer | X | 초기화 요일 1: 일요일 , 2. 월요일 , 3.화요일 , 4.수요일 , 5.목요일 , 6.금요일 , 7.토요일 (periodType가 weekly 일때) |
resetTime | String | X | 초기화 시간 |
resetDate | Integer | X | 초기화 날짜 1~31 (periodType가 monthly 일때) |
ranking | String | O | 랭킹 업데이트 기준 ( latest, accumulated, best ) |
tie_breaking | String | O | 동점자 처리 기준 ( first, last) |
실패
Attribute | Type | Description |
---|
code | Int | 결과 값 (1: 성공, 실패 시 Error code 참고) |
error | String | 오류 내용 |
의견을 보내 주셔서 감사합니다! 우리 팀이 당신에게 돌아갈 것입니다.