开放能力

开放 API 文档

短链创建、查询与卡片数据均可通过 API 接入你自己的系统 —— 基于 API Key 与 Scope 的最小化授权模型,签发即可调用, 接口契约与在线文档完全公开、无需登录即可查阅。

开放的能力

按需申请权限范围(scope),密钥只拥有你勾选的能力,而非全量账号权限。

短链读取
chain:read

查询短链详情、访问统计等只读数据,用于自建报表或监控。

短链创建
chain:write

以编程方式批量创建 / 管理短链,接入自有工单、CRM 或投放系统。

卡片读取
card:read

读取卡片(落地页 / H5)系统数据,用于自建数据看板。

鉴权与限流
Bearer sk_…

每把密钥独立授予 scope、限流(次/分)与日配额,遵循最小权限原则。

如何接入

四步完成从注册到第一次真实调用。

  1. 注册 / 登录后台
    进入「开放API」▸「APIKey」管理页面。
  2. 签发密钥
    按需选择权限范围(scope),可选设置限流与每日配额;密钥仅在签发 / 重置时显示一次,请妥善保存。
  3. 发起调用
    使用 Authorization: Bearer sk_… 调用 /open/v1/* 接口。
  4. 查阅完整契约
    接口路径、参数与返回结构见下方的 OpenAPI 规范或 Swagger UI —— 两者均由后端接口注解自动生成,与线上实现始终一致。

开放接入

准备好接入了吗

登录后台签发密钥,几分钟内即可发起第一次真实调用。