API 总览
面向短链接、数据分析、域名和合作伙伴运营的 REST API v1:基础 URL、密钥类型、权限以及白标模式。
更新于 2026年8月13日
控制台能做的一切,API 同样能做:创建带定向和 A/B 分流的短链接、读取数据分析、接入域名、管理客户和套餐。API 是一等的产品能力入口——控制台和 API 运行同一套代码,执行同样的限制。
基础 URL
https://api.linkprofit.com/v1
所有请求都使用 HTTPS 和 JSON。除二维码图片和 CSV 导出外,响应均为 JSON。始终保持最新的交互式参考文档位于 /docs/api/reference,它由校验每个请求所用的同一套 schema 生成。
两类密钥
| 密钥前缀 | 作用范围 | 创建位置 | 可访问 |
|---|---|---|---|
| lp_live_… | 工作区 | 工作区设置 → API 密钥 | /links、/analytics、/domains、/workspace、/events、/webhooks |
| lpp_live_… | 合作伙伴 | 合作伙伴设置 → API 密钥 | /partner/* 和 /webhooks |
工作区密钥在单个客户工作区内生效。合作伙伴密钥管理合作伙伴账户:客户、套餐、域名、付款。密钥带有权限,用于限定每个密钥能做什么。
版本管理
v1 已冻结:字段只会新增,不会重命名或删除。不兼容的变更会以 /v2 的形式发布。请基于文档中列出的字段开发,并忽略未知字段。
白标:把 API 提供给你的客户
如果你运营白标短链接服务,API 也是你转售的产品之一:
- 密钥由你来发放。 每个客户在自己的品牌控制台中创建工作区密钥(设置 → API 密钥)——你的合作伙伴密钥永远不需要共享出去。
- 主机名仍是共享的。 在 v1 中,所有 API 流量都发往
api.linkprofit.com——尚不支持为每个合作伙伴配置独立的 API 域名。把基础 URL 写作「你自己服务的 API 主机名」;响应中不含任何 LinkProfit 品牌信息。 - 限制随你的套餐而定。 API 访问是你所售套餐上的一个功能开关(
api_access),每个密钥的速率限制来自套餐。使用不含 API 访问的套餐的客户会收到403 plan_restricted。
参见白标指南,其中有一份可直接取用的页面,你可以改写后放进自己的开发者文档。