> 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/chinese-simplified/api-wen-dang-tu-pian/biao-zhun-tao-can.md).

# 标准套餐

## 认证

GGWP 使用 API 密钥为经授权的用户授予对下方列出的所有 API 端点的安全访问。所有请求都必须在提供的 API 密钥之外再提供以下 HTTP 头：

`x-api-key: <API_KEY>`

每个 API 密钥：

* 唯一标识您的平台/游戏
* 赋予对本文档中列出的所有 API 的访问权限
* 具有特定的速率限制，即每秒可发出的请求数，同时也可能设有按月可发出的请求配额
* 应妥善保密，不应与任何未经授权的游戏/用户共享
* 一旦丢失，就必须重新生成一个新密钥

请联系您的 GGWP 客户经理，以配置 API 密钥并设置您的游戏所需的正确速率限制。

## 如何使用您的 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":"禁止访问"}* 关闭连接 0
```