> 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-1/pakkji.md).

# 標準パッケージ

## 認証

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/image/v1/moderate' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-api-config: <BASE64_CONFIG>' \
  --header 'x-api-processing-mode: quality' \
  -F "file=@/path/to/example.jpeg" \
  -F "file_name=avatar123.jpeg" \
  -F "user_id=user989"
```

無効な 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
```
