白 小白云IDC授权中心
白
小白云IDC · 授权中心
开放接口 · 与产品同版本发布

开放接口文档

IDC 客户端通过以下接口完成授权校验、心跳、版本更新、插件安装与公告同步。所有响应均为 JSON,包含 ok 与 message 字段;失败时 ok=false,message 可直接在 IDC 后台展示。

接入信息

项目值
接口根地址http://auth.mihrim.cn/index.php
数据格式application/json 或 x-www-form-urlencoded
鉴权方式授权码 code;管理员操作另需 API Token(后台「API 令牌」生成)

接口一览

方法路径名称说明
POST index.php?r=api/license/verify 授权校验 提交 code + domain,返回授权状态、版本、绑定站点列表与下载地址;首次校验自动绑定域名,未达站点上限时新站点自动加入绑定。
POST index.php?r=api/license/heartbeat 心跳上报 每 6~24 小时上报一次 code + domain + ip(建议附带 sig=HMAC(CODE|host|ts) 与 ts 时间戳防篡改),失败/被吊销会立即返回错误,用于在线吊销。
POST index.php?r=api/license/offline 离线授权文件 返回带 HMAC-SHA256 签名的 JSON 授权文件,可在内网/无外网环境校验。
POST index.php?r=api/program/version 版本检测 返回最新版本、发布渠道、强制更新标记、安装包哈希与下载地址。
GET index.php?r=api/program/download&code=xxx 系统包下载 校验授权码后下载系统安装包。
POST index.php?r=api/store/plugins 商城插件列表 返回插件依赖、试用天数、兼容版本范围与下载地址。
GET index.php?r=api/store/download&code=xxx&slug=yyy 插件包下载 校验授权码后下载插件安装包。
POST index.php?r=api/announcements 公告拉取 返回最新公告与版本更新,IDC 后台可同步展示。
POST index.php?r=api/license/revoke 吊销授权(管理员) 需携带 X-API-Token;支持单码吊销、批量吊销与恢复。
POST index.php?r=api/payment/callback 支付回调 第三方支付成功回调:校验订单号/金额/签名后将订单标记为已支付并写入支付流水。

授权校验

POST ?r=api/license/verify,参数 code(授权码)与 domain(站点域名)。首次校验自动绑定域名;校验响应同时携带最新版本号、渠道、强制更新标记与安装包下载地址,客户端可直接据此实现「检查更新」。

离线授权文件

离线授权文件为 JSON,字段 signature 为其余字段按 JSON 序列化后的 HMAC-SHA256 值。校验方使用授权中心后台「离线授权密钥」进行签名比对,并检查 expires_at 与 domain。

版本检测

POST ?r=api/program/version,参数 code。返回当前发布渠道的版本号、包哈希、强制更新标记与下载地址;带溯源水印的分发由下载接口在响应流中完成。

校验返回示例

{
  "ok": true,
  "message": "授权校验通过",
  "license": {
    "code": "XY-8F2A-91CD-4E7B-6K3M",
    "plan": "standard",
    "plan_name": "标准版",
    "edition": "V3正式版",
    "channel": "stable",
    "system_version": "3.7.15",
    "expires_at": "2027-11-09 12:00:00",
    "domain": "idc.example.com",
    "force_update": false,
    "download_url": "http://auth.mihrim.cn/index.php?r=api/program/download&code=..."
  }
}
安全提示:心跳与版本接口建议同时上送 ts 与 sig(HMAC),授权中心会校验时间窗口,防止重放。管理员类接口(吊销/恢复)必须携带 X-API-Token,并在后台令牌页管理。

小白云IDC 开放接口文档 · 与产品同版本发布 · 安装部署见《安装部署手册》,日常使用见《使用手册》