> For the complete documentation index, see [llms.txt](https://docs.ggwp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ggwp.com/kr/api-5.md).

# API 문서: 이의 제기

## **소개**

GGWP는 플레이어가 제재가 부당하다고 생각하여 재심사 또는 해제를 요청할 수 있도록 하는 API를 제공합니다.

## 인증

GGWP는 API 키를 사용하여 승인된 사용자에게 아래에 나열된 모든 API 엔드포인트에 대한 보안 액세스를 부여합니다. 모든 요청은 프로비저닝된 API 키와 함께 다음 HTTP 헤더를 제공해야 합니다:

`x-api-key: <API_KEY>`

각 API 키는:

* 플랫폼/게임을 고유하게 식별합니다
* 이 문서에 나열된 모든 API에 대한 액세스를 제공합니다
* 초당 요청 수에 대한 특정 속도 제한과 월간 기준으로 수행할 수 있는 요청 수의 할당량이 있을 수 있습니다
* 비밀로 유지되어야 하며 승인되지 않은 게임/사용자와 공유해서는 안 됩니다
* 한 번 분실되면 새 키를 다시 생성해야 합니다

API 키 제공 및 게임에 필요한 올바른 속도 제한 설정을 위해 GGWP 담당 계정 관리자에게 문의하십시오.

## API 키 사용 방법

다음은 유효한 API 키(예제에서는 키가 가려져 있음)를 사용하여 프로덕션 API 엔드포인트를 호출하는 예입니다:

```bash
curl --request POST 'https://api.ggwp.com/users/v1/appeals' \
--header 'x-api-key: api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
        "user_id": "test-user", 
        "channel": "chat", 
        "comment": "wronng sanction"
}'
```

유효하지 않은 API 키는 `403` 응답 코드를 반환합니다. 아래는 유효하지 않은 API 키로 받은 예시 응답입니다:

```bash
< HTTP/2 403
< date: Thu, 18 Nov 2021 21:28:27 GMT
< content-type: application/json
< content-length: 23
< x-amzn-requestid: f4361ec6-71bc-478f-98cd-da0fe9df829b
< x-amzn-errortype: ForbiddenException
< x-amz-apigw-id: JBPLRHGjPHcFdbg=
<
* Connection #0 to host api.ggwp.com left intact
{"message":"Forbidden"}* Closing connection 0
```

## 항소 API

\[ 기본 URL: `api.ggwp.com`]

`POST` /users/v1/appeals

### **설명**

이 API 엔드포인트는 플레이어의 제재에 대한 항소를 처리합니다. 플레이어는 제재가 정당하지 않다고 생각하여 제재의 완화 또는 해제를 원할 수 있습니다.

### **매개변수**

`본문`: 다음 필드를 포함하는 사전:\
(*utf-8 인코딩이어야 합니다)*

* **user\_id:** 항소를 제출하는 사용자의 고유 식별자.

  ```json
  user_id = "anonymous_sessionID"
  ```
* **channel (선택 사항):** 제재가 적용된 위치를 나타냅니다. 지원되는 채널은 `채팅`, `음성`, `게임` 및 `discord`.
* **comment**: 검토자에게 제출하는 플레이어의 제재 관련 텍스트 메시지.&#x20;

예시

```json
{
  "user_id": "test-user", 
  "channel": "chat", 
  "comment": "wronng sanction"
}
```

샘플 호출:

```bash
curl --request POST 'https://api.ggwp.com/users/v1/appeals' \
--header 'x-api-key: api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
        "user_id": "test-user", 
        "channel": "chat", 
        "comment": "wronng sanction"
}'
```

### **출력**

* 200 응답 - 성공적인 작업

```json
{
    "message": "Success"
}
```

* 400
  * 잘못된 입력 json 입력, 필수 필드 누락.
* 403
  * 잘못되었거나 누락된 API 키