API 集成

GoRelay 提供 Open API，支持通过程序化方式管理隧道、查询流量等操作。

获取 API Key

1. 登录控制台，进入「用户 → 个人中心」
2. 找到「API Key」一栏，复制您的 API Key

安全提示

API Key 具有账号完整操作权限。请勿将 API Key 提交到代码仓库或在不可信环境中使用。建议通过环境变量管理。

查阅 API 文档

GoRelay 的完整 API 文档可在控制台的「工具 → API 文档」中查看（外部链接，在新标签页打开）。

API 文档包含所有可用接口的详细说明，包括：

• 请求方法和路径
• 请求参数说明
• 响应格式示例
• 认证方式

认证方式

所有 API 请求需要在 Header 中携带 API Key：

Authorization: Bearer YOUR_API_KEY

代码示例

Python

import requests

API_KEY = "your-api-key"
BASE_URL = "https://gorelay.net/api"  # 以实际 API 文档中的地址为准

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

# 获取隧道列表
response = requests.get(f"{BASE_URL}/tunnels", headers=headers)
tunnels = response.json()
print(tunnels)

Node.js

const axios = require('axios');

const API_KEY = process.env.GORELAY_API_KEY;
const BASE_URL = 'https://gorelay.net/api'; // 以实际 API 文档中的地址为准

const client = axios.create({
  baseURL: BASE_URL,
  headers: { Authorization: `Bearer ${API_KEY}` }
});

// 获取隧道列表
async function getTunnels() {
  const { data } = await client.get('/tunnels');
  return data;
}

信息

API 的具体接口路径、参数和响应格式请以控制台「工具 → API 文档」页面中的最新文档为准，本文仅做示例参考。