> 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/jp/apidokyumento-shite.md).

# APIドキュメント: 異議申し立て

## **はじめに**

GGWP は、プレイヤーが制裁が不公正に適用されたと考え、その見直しや解除を求めて異議申し立てを行える API を提供します。

## 認証

GGWPでは、APIキーを使用して、認可されたユーザーに以下に記載されているすべてのAPIエンドポイントへの安全なアクセスを付与します。すべてのリクエストでは、発行されたAPIキーとともに次のHTTPヘッダーを指定する必要があります:

`x-api-key: <API_KEY>`

各APIキーは：

* あなたのプラットフォーム/ゲームを一意に識別します
* このドキュメントに記載されているすべてのAPIへのアクセスを可能にします
* 1秒あたりに行えるリクエスト数に固有のレート制限があり、さらに月単位で行えるリクエスト数の固定クォータが設定される場合があります
* 秘密に保持し、権限のないゲーム／ユーザーと共有してはなりません
* 紛失した場合は、新しいキーを再生成する必要があります

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 エンドポイントは、制裁に対するプレイヤーの異議申し立てを処理します。プレイヤーはその制裁が正当でないと考え、軽減または削除を求める場合があります。

### **パラメータ**

`本文`: 以下のフィールドを含む辞書:\n(*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": "成功"
}
```

* 400
  * 無効な入力 JSON、必須フィールドがありません。
* 403
  * 無効な API キー、または API キーがありません