# 통합게임점검 체크 API
# 소개
게임 점검 여부 정보를 제공합니다.
별도 도메인 및 CDN을 통해 30초 캐시가 적용됩니다.
점검 조회 API 의 응답 값이 점검 상태 + 인증된 유저일 경우, 해당 게임에 대한 화이트리스트 유저 여부(통합점검 화이트유저 체크 API)를 조회하여 화이트 유저인 경우 게임 실행 버튼을 활성화 합니다.
# 기본정보
GET /v2.0/maintenance/{category}/{service_id1}/{service_id2}/{lang}
Host:
https://maintenace.gate8.com (SANDBOX)
https://maintenace.onstove.com (LIVE)
Content-Type: application/json
1
2
3
4
5
2
3
4
5
# Request
# Header
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| caller-id | String | Y | - | {game_id}_HOME | API 호출자 정보 -{game_id}_HOME(공홈) -{game_id}_SERVER(서버) |
# Path Variable
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| category | string | Y | "GAME" OR "PLATFORM" | 카테고리 -게임점검(GAME) -플랫폼점검(PLATFORM) -커뮤니티점검(COMMUNITY) - N/A | |
| service_id1 | string | Y | IF CATEGORY IS "GAME" -{game_id} -ex) STOVE_WONDERERS IF CATEGORY IS "PLATFORM" ex) STOVE_WEB ex) STOVE_CLIENT | 서비스 아이디1 | |
| service_id2 | string | Y | IF CATEGORY IS "GAME" -{market_name} -ex) PC_MARKET IF CATEGORY IS "PLATFORM" ex) HOME ex) LOGIN | 서비스 아이디2 | |
| lang | string | N | "ko" "en" | 언어 코드(미입력 시 점검 설정 시 기본 언어로 조회) |
# Response
# Body
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| code | Integer | Y | - | 0 | 응답 코드 |
| message | String | Y | - | OK | 응답 메시지 |
| value | Object | N | - | {"code":0,"message":"OK","value":{}} | 응답 값 |
# value
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| maintenance_no | integer | - | - | 점검번호 | |
| category | string | - | - | 카테고리 | |
| service_id1 | string | - | - | PLATFORM, GAME, COMMUNITY | |
| service_id2 | string | - | - | 플랫폼 마켓 명 ex) PC게임 일 경우 (PC_MARKET) 사용, 모바일 게임 점검일 경우 ( NHN_N_STORE, APPLE_APP_STORE, GOOGLE_PLAY, SKT_T_STORE, AMAZON_APP_STORE ) 사용 -SGS 기술PM 팀 문의 | |
| type | string | - | - | 점검타입 ex) REGULAR, TEMPORARY, URGENT | |
| languages | object array | - | - | 언어별 정보 * 페이지 내 languages properties 참고 | |
| description | string | - | - | 설명 | |
| start_at | integer | - | - | 점검 시작일(milli-timestamp(13digit)) * UTC +0 시간 / 조회 시 각 국가별 기준시간 대로 변경해서 사용 | |
| end_at | integer | - | - | 점검 종료일(milli-timestamp(13digit)) * UTC +0 시간 / 조회 시 각 국가별 기준시간 대로 변경해서 사용 |
# languages
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| lang | string | - | - | 언어코드 | |
| title | string | - | - | 점검제목 | |
| content | string | - | - | 점검내용 | |
| link | string | - | - | 링크 |
# Sample
# Request
curl -X GET "https://maintenance.onstove.com/v2.0/maintenance/GAME/test_game_id/PC_MARKET/ko" -H "caller-id: test_game_id_HOME"
1
# Response
점검 중 일 때
{
"code": 0,
"message": "OK",
"value": {
"category": "GAME",
"description": "",
"end_at": 1693526400000,
"languages": [
{
"lang": "ko",
"title": "정기 점검",
"content": "현재 정기 점검 진행중입니다.\n\n\n■ 점검 시간\n\n xx:00 ~ xx:00 \n*점검은 조기 종료될 수 있습니다",
"link": "https://page.onstove.com/test_game_id/ko/maintenance"
}
],
"maintenance_no": 13,
"service_id1": "test_game_id",
"service_id2": [
"*"
],
"start_at": 1661990400000,
"type": "REGULAR"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
점검 중이 아닐 때,
{
"code": 0,
"message": "OK",
"value": {}
}
1
2
3
4
5
2
3
4
5
# Return Code
| HTTP Status code | response_code | response_message | Description |
|---|---|---|---|
| 200 | 0 | success | 성공 |
| 200 | 400 | Bad Request | 잘못된 요청 |
| 200 | 70001 | Invalid access token | - |
| 200 | 70002 | Invalid Handshaking ticket | - |
| 200 | 70003 | DB is not initialized | - |
| 200 | 70005 | Storage is not initialized | - |
| 200 | 70006 | Invalid API version | - |
| 200 | 70007 | Invalid Application No | - |
| 200 | 70008 | Invalid Game No | - |
| 200 | 70009 | You do not have permission to access the resource | - |
| 200 | 70051 | Parameter is invalid | 잘못된 파라미터 |
| 200 | 70052 | Cannot find data | - |
| 200 | 77800 | error occurs when connect to DB | - |
| 200 | 77801 | error occurs when user invaild access token | - |
| 200 | 77820 | check api parameter | - |
| 200 | 77821 | check api parameter's default key | - |
| 200 | 77822 | check api parameter body's data key | - |
| 200 | 77823 | check api parameter's data type | - |
| 200 | 77824 | build result json format error | - |
| 200 | 77825 | check uri resource name | - |
| 200 | 77826 | not found api (check method version) | - |
| 200 | 77831 | error occured in membership infra token api | - |
| 200 | 77836 | error occurs when invaild maintenance no | - |
| 200 | 77899 | System error | - |