# 통합게임점검 화이트유저 체크 API
# 소개
통합게임점검체크API를 통해 점검 중인 상태일 때에만 화이트유저 체크 API 연동을 통해서 화이트 리스트 유저 적용을 합니다.
비인증 유저(토큰이 없는 유저)는 화이트유저 체크 API를 호출하지 않습니다.
- 비인증 유저로 요청하더라도 응답은 {"is_whiteuser": false}로 내려주지만 불필요한 통신 비용 감소를 위해 연동하지 않도록 처리 필요합니다.
# 기본정보
GET /maintenace/v2.0/whiteuser/check
Host:
https://api.gate8.com (SANDBOX)
https://api.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 |
|---|---|---|---|---|---|
| Authorization | String | Y | Bearer {Access Token} | bearer {web Access Token} | 플랫폼의 API를 사용하기 위한 web Access Token |
| caller-id | String | Y | - | {game_id}_HOME | API 호출자 정보 -{game_id}_HOME(공홈) -{game_id}_SERVER(서버) |
# Parameter (Query String)
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| category | string | Y | - | "GAME" | 카테고리 게임점검(GAME) |
| service_id1 | string | Y | - | "STOVE_WONDERERS" | 서비스 아이디1(플랫폼 game_id) |
| device_id | string | N | - | {device_id} | 디바이스 아이디(디바이스 화이트 체크일때만 사용) |
# Response
# Body
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| code | Integer | Y | - | 0 | 응답 코드 |
| message | String | Y | - | OK | 응답 메시지 |
| value | Object | Y | - | {"code":0,"message":"OK","value":{}} | 응답 값 |
# value
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| is_whiteuser | bool | Y | - | true : whiteuser - false: Block |
# Sample
# Request
curl -X GET 'https://api.onstove.com/maintenance/v2.0/whiteuser/check?category=GAME&service_id1=test_game_id' -H "authorization: bearer eyJhbGciOiJIUzI1NiJ9.eyJleHBpcmVfdGltZSI6MTY4NjgxNTM4MTU1NiwibWVtYmVyX25vIjozMDEwMjYsImFwcGxpY2F0aW9uX25vIjo0OTA3MX0.vhtQwRKCuR12zV2kWMkSQbb-SWiq14L6rO8obvbre7OtmqbRR8_0wb1HT45IzD3VkCYt1gaNaefxO6xHe6Ndm9cm-ucCLPpomyNvvDHs0oRZxEhnf5RziZsFiKBZXtR2XqNKDfMDpUZryHdm6VLWlzt7x6XBTk1D_sjNqj6aAjPrnmk-PPG2S5Qblq6bQd379aLC7WGAS0qYolK36uTcjL1K6yhGP7_udJtkCHdJ27aQssmoEHdkrWhG35-yhOx6Gbk00Sefjo6SyIPBwLqU_w" -H "caller-id: test_game_id_client" -H "caller-detail: 5e853230-a43b-4ca3-9376-0faf3eceb69e"
1
# Response
{
"code": 0,
"message": "OK",
"value": {
"is_whiteuser": false
}
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# Return Code
| HTTP Status code | response_code | response_message | Description |
|---|---|---|---|
| 200 | 0 | success | 성공 |
| 200 | 400 | Bad Request | 잘못된 요청 |
| 200 | 500 | Internal Sever Error | - |
| 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 | - |