跳到主要内容
版本：6.x

API调用方法

调用需要身份验证的管理员 API 时，可使用以下两种方式之一。

API密钥​

API 密钥长期有效，适合服务端程序、自动化任务等不便频繁登录的场景。

在管理员后台的“系统管理 → API密钥”中开启后，可以获得 API Key 和 API Secret。调用 API 时，必须同时发送以下两个请求头：

  • api-key：填写 API Key。
  • api-secret：填写 API Secret。
curl \
  -H 'api-key: YOUR_API_KEY' \
  -H 'api-secret: YOUR_API_SECRET' \
  'https://master.example.com/v1/sites/1'

请将示例中的主控域名、YOUR_API_KEY 和 YOUR_API_SECRET 替换为实际值。API Secret 仅在可信环境中保存和使用，不要写入前端代码或公开仓库。

Access Token​

Access Token 有有效期，适合登录后的临时调用。先通过登录接口获取令牌，再通过 access-token 请求头调用其他 API。

1. 登录并获取令牌​

curl -X POST \
  -H 'Content-Type: application/json' \
  -d '{"account":"YOUR_ACCOUNT","password":"YOUR_PASSWORD"}' \
  'https://master.example.com/v1/login'

account 可以填写用户名、手机号或邮箱地址。登录成功后，响应的 data.access_token 即为访问令牌：

{
  "code": 0,
  "msg": "登录成功",
  "data": {
    "access_token": "YOUR_ACCESS_TOKEN"
  }
}

2. 使用令牌调用 API​

curl \
  -H 'access-token: YOUR_ACCESS_TOKEN' \
  'https://master.example.com/v1/sites/1'

请将示例中的主控域名和 YOUR_ACCESS_TOKEN 替换为实际值。令牌过期后，需要重新登录获取。