首页/文档中心/API 接口参考(v1)

API 接口参考(v1)

ABcloakPro API 采用 RESTful 设计,可将链接与规则管理集成到您自己的投放系统中。本文档对应 v1 版本,与 API 交互演示页配套使用。

基础信息

项目
Base URLhttps://api.abcloakpro.com/v1
协议HTTPS(强制 TLS)
数据格式JSON(请求与响应均为 application/json
限流60 次/分钟/账户,超限返回 429

认证方式

所有请求通过 API 密钥认证,密钥在控制台「账户设置 → API 密钥」中获取,以 Bearer 方式置于请求头:

Authorization: Bearer {YOUR_API_KEY}
密钥安全API 密钥等同于账户管理权限,请勿写入前端代码或公开仓库。泄露后可在控制台立即重置。

创建路由

POST /v1/routes

{
  "name": "春季投放-渠道A",
  "page_a": "https://example.com/page-a",
  "page_b": "https://example.com/page-b",
  "split_ratio": 0.5,
  "default_group": "a"
}

响应(201 Created):

{
  "id": 1024,
  "short_url": "https://www.abcloakpro.com/r/xK9fQ",
  "status": "active",
  "created_at": "2026-09-09T10:30:00Z"
}

查询路由

GET /v1/routes            # 列表(支持 ?page=1&limit=20)
GET /v1/routes/1024       # 单条详情(含访问统计)

单条详情响应包含近 7 日点击量、分组分布与规则命中统计。

更新路由

PUT /v1/routes/1024

{ "split_ratio": 0.7 }

支持部分更新,仅提交需要变更的字段即可。响应返回更新后的完整对象。

删除路由

DELETE /v1/routes/1024    # 成功返回 204 No Content
说明删除路由后其跳转链接立即失效。链接创建额度为终身累计,删除不返还额度(详见《套餐与计费》)。

错误码

HTTP 状态码含义处理建议
400参数错误(响应含具体字段)按 response.error 字段修正
401密钥缺失或无效检查 Authorization 头
404路由不存在确认路由 id
429请求超过限流退避重试,间隔 ≥ 1s
500服务端异常稍后重试,持续出现请联系支持