API 文档

鉴权方式

在 工作台 → API 密钥 创建密钥，请求时通过以下任意一种方式携带：

X-API-Key: sk_live_xxxxxxxx
# 或
Authorization: Bearer sk_live_xxxxxxxx
# 或
?api_key=sk_live_xxxxxxxx

密钥使用 SHA-256 摘要存储，明文仅在创建时展示一次，请妥善保存。

返回格式

{
  "code": 0,
  "message": "ok",
  "data": { ... }
}

code 为 0 表示成功；非 0 时 message 为错误原因。HTTP 状态码：200 / 401 / 404 / 422 / 429 / 500。

获取工具清单

GET /api/v1/tools

返回全部工具及其参数定义（fields）。

调用工具

GET|POST /api/v1/run/{tool_id}

例如：

GET /api/v1/run/whois?domain=sirvps.com
GET /api/v1/run/dns?domain=sirvps.com&type=A
GET /api/v1/run/ssl?host=sirvps.com
GET /api/v1/run/ip-geo?ip=1.1.1.1
GET /api/v1/run/seo-audit?url=https://sirvps.com
POST /api/v1/run/tdk
  keywords=VPS 比价
  lang=zh

curl 示例

curl -H "X-API-Key: sk_live_xxx" \
  "https://sirvps.com/api/v1/run/whois?domain=sirvps.com"

PHP 示例

$ch = curl_init('https://sirvps.com/api/v1/run/dns?domain=sirvps.com&type=A');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-Key: sk_live_xxx']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$json = json_decode(curl_exec($ch), true);

Python 示例

import requests
r = requests.get("https://sirvps.com/api/v1/run/ssl",
                 params={"host": "sirvps.com"},
                 headers={"X-API-Key": "sk_live_xxx"})
print(r.json())

速率限制

默认每密钥每分钟 60 次，可在后台调整。超限返回 429。