# API 参考

使用 HTTP 请求访问 Edgegap 资源的管理功能。

<a href="https://raw.githubusercontent.com/edgegap/openapi-specification/refs/heads/main/edgegap-v2-openapi.yaml" class="button primary" data-icon="square-down">下载 openapi \[v2]</a> <a href="https://api.edgegap.com/swagger.json" class="button secondary" data-icon="square-down">下载 openapi \[v1]</a>&#x20;

### 认证令牌

在以下位置生成（并查看）您的 Edgegap API 密钥： [仪表板 - 用户设置 / 令牌](https://app.edgegap.com/user-settings?tab=tokens).

在每个 API 请求中将您的密钥作为 HTTP 头添加（包含单词 `token`):

`Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62`

{% hint style="danger" %}
**不要将 Edgegap API 端点集成到游戏客户端，因为您的 API 令牌会为您的账户提供无限制访问。参见** [Broken link](https://docs.edgegap.com/zh/docs/broken-reference "mention") **以获取面向客户端的安全 API 端点和功能。**
{% endhint %}

{% hint style="success" %}
如果您的密钥被泄露，请删除它们并更新组织成员密码。
{% endhint %}

### 响应分页

如果响应包含过多项目，我们会返回带有分页信息的数据子集：

<pre class="language-json"><code class="lang-json">{
  "count": 100,
  "data": ["foo-0", "[...]", "bar-9"],
  "<a data-footnote-ref href="#user-content-fn-1">pagination</a>": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": null
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}
</code></pre>

对于分页响应，使用参数 `page` 和 `limit`  以检索更多结果：

* 第二页： `https://api.edgegap.com/v1/apps?`**`page=2`**
* 更多结果： `https://api.edgegap.com/v1/apps?`**`limit=20`**
* 组合： `https://api.edgegap.com/v1/apps?`**`page=2&limit=20`**

### 速率限制

为了保证平台稳定并防止意外账单，我们对贵组织的 API 使用进行速率限制：

* [deployments](https://docs.edgegap.com/zh/learn/bian-pai/deployments "mention") 每秒 40 次请求，
* [#context-and-status](https://docs.edgegap.com/zh/learn/bian-pai/deployments#context-and-status "mention") 每秒 20 次请求。

{% hint style="info" %}
[联系我们](mailto:info@edgegap.com) 以 **规划发布、进行负载测试、估算上线流量并为成功做准备。**
{% endhint %}

[^1]: 包含分页信息