> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Gorelo API 概述

> 使用 Gorelo API 集成外部产品和第三方应用，通过 X-API-Key 请求标头进行 API 密钥认证，支持作用域权限管理、HTTP 错误码处理、请求限速控制、端点调用示例、响应状态码解析、身份验证流程和开发者最佳实践，助力开发团队快速接入自动化工作流。

Gorelo 允许你通过 Gorelo API 与任何外部产品集成。

Gorelo API 使用 API 密钥。在每次请求中通过 X-API-Key 标头包含你的密钥。

Gorelo 的基础 URL 取决于你选择在 Gorelo 中托管数据的区域：

<Tabs>
  <Tab title="US">
    基础 URL：[**https://api.usw.gorelo.io/**](https://api.usw.gorelo.io/)\
    API 参考：[**https://api.usw.gorelo.io/swagger**](https://api.usw.gorelo.io/swagger)
  </Tab>

  <Tab title="Australia">
    基础 URL：[**https://api.aue.gorelo.io/**](https://api.aue.gorelo.io/)\
    API 参考：[**https://api.aue.gorelo.io/swagger**](https://api.aue.gorelo.io/swagger)
  </Tab>
</Tabs>

## 作用域和权限

API 密钥可以**限定作用域**。如果某个密钥对某端点没有访问权限，API 会返回 **403 Forbidden**。

## 错误处理

| 错误                        | 含义            |
| :------------------------ | :------------ |
| **401 Unauthorized**      | 缺失/无效的 API 密钥 |
| **403 Forbidden**         | 密钥有效，但作用域不足   |
| **429 Too Many Requests** | 超出速率限制        |

## 状态 ID

## 代理资产

| ID | 状态                    |
| :- | :-------------------- |
| 1  | Installing            |
| 2  | Online                |
| 3  | Offline               |
| 4  | Pending Delete        |
| 5  | Deleted               |
| 6  | Pending Client Delete |
| 7  | Client Deleted        |