API 只返回您自己的数据,别无其他:您账号下的收录页面、它们的表现、他人在这些页面上留下的评价,以及您列入关注的竞品。它是只读 API。所有会修改数据的操作都在管理后台完成,因此即使密钥泄露,别人也只能复制您的数字,无法编辑您的收录页面,无法花钱,也无法触碰任何其他人的账号。
它和这里的其他功能一样免费。每个账号都可以在管理后台生成密钥。
密钥
请在管理后台的收录工具标签页中,找到名为“导出与 API 访问”的区块创建密钥。密钥的格式是 sl_ 加 48 个十六进制字符,管理后台会显示它的签发日期。
每个账号一个密钥。 点击“新建密钥”会生成新密钥,旧密钥在那一刻立即失效。没有宽限期,也不能同时运行第二个密钥,所以请在您准备好更新所有使用它的地方时再更换。
需要轮换密钥的情况: 它出现在公开代码仓库、共享文档、浏览器里,或者出现在您已停用的服务中。轮换只需点击一次,不收费。
吊销密钥的方法是在同一区块中将其删除。账号照常使用,只是 API 访问停止。
请把密钥当作密码对待。把它放在服务器上、环境变量或密钥存储中,绝不要放进前端代码:浏览器中的任何内容,打开页面的人都能读到。我们有意不在这些接口上发送 CORS 头,因此其他域名上的浏览器页面无法用您的密钥调用它们。
调用方式
每个请求都在 Authorization 头中携带密钥。基础地址是 https://saasledge.com/api/v1。
curl -H "Authorization: Bearer sl_your_key" \
https://saasledge.com/api/v1/me
响应为 JSON,带有 "ok": true。错误响应保持相同结构,带有 "ok": false 和一个简短的机器可读代码。
| 状态码 | 代码 | 含义 |
|---|---|---|
| 401 | unauthorized |
没有密钥、密钥格式错误,或密钥已不存在 |
| 402 | plan_required |
密钥有效,但账号未使用 Studio |
| 429 | rate |
此密钥一分钟内的请求超过 120 次 |
限制是每个密钥每分钟 120 次请求。对于每晚一次的导出来说绰绰有余,对于忘了停下来的循环来说则很紧。
GET /api/v1/me
密钥所属的账号,以及其他一切所依据的限额。可用作健康检查。
{
"ok": true,
"account": {
"email": "[email protected]",
"products": 3,
"since": "2026-08-13"
},
"key": { "issued_at": "2026-08-14 09:12:33" },
"limits": {
"products": 25,
"watches": 25
},
"rate": { "limit": 120, "per": "minute" }
}
GET /api/v1/products
您的收录页面及其上发布的全部内容:状态、分类、定价模式、方案、截图数量、评价数量和平均评分。每一项都带有 url_on_saasledge,即该收录页面的公开地址。
curl -H "Authorization: Bearer sl_your_key" \
https://saasledge.com/api/v1/products
GET /api/v1/stats
收录页面的浏览量,以及跳转到您网站的点击量,按天分组。
| 参数 | 默认值 | 说明 |
|---|---|---|
days |
30 | 1 至 365 |
product |
all | 收录页面的 slug,例如 wave |
format |
json | csv 返回一个文件,列为 product,day,views,clicks |
没有事件的日期不会返回。合计值已在 totals 中为您算好,包括以百分比表示的点击率。
curl -H "Authorization: Bearer sl_your_key" \
"https://saasledge.com/api/v1/stats?days=90&format=csv" -o stats.csv
GET /api/v1/reviews
您的收录页面上已发布的评价,附带您的回复和日期。without_reply 统计仍在等待回复的评价数量,这个数字最值得设置告警。
| 参数 | 默认值 | 说明 |
|---|---|---|
days |
90 | 1 至 365 |
product |
all | 收录页面的 slug |
评价者的邮箱地址永远不会返回。收集它们是为了让我们核实评价,而不是为了给他们发邮件。
GET /api/v1/watches
您关注列表中的竞品:当前入门价和上次变动前的入门价、方案数量、是否有免费版和试用、评分、评价数量,以及时间窗口内的价格历史。同一响应还带有 mine,即您自己已上线收录页面的入门价和方案数量,这样一次对比只需一次请求,而不是两次。
| 参数 | 默认值 | 说明 |
|---|---|---|
days |
90 | 1 至 365,适用于价格历史 |
API 不会做的事
它不会显示其他厂商的私有数据,不会写入任何内容,也不会导出整个目录。批量复制目录既不是我们出售的东西,也不是密钥能够打开的权限。
如有疑问,或者您的用例需要一个我们尚未返回的字段:请写信到 [email protected],说明您在构建什么。