向你的客户提供 API

你的客户可以像你自动化合作伙伴账户那样，自动化管理自己的短链接。本页是一份操作手册，教你把 API 变成你自己产品的一项功能——其中也包含可以直接改写进你自有开发者文档的文案。

工作方式

• 客户自行创建密钥。 每个使用了包含 API 访问权限套餐的工作区，都能在品牌化控制台里找到设置 → API 密钥。密钥归属于工作区：完全不涉及你的合作伙伴密钥，客户也只能访问自己的数据。
• 主机名是共享的。 所有请求都发送到 https://api.linkprofit.com/v1。v1 版本暂不支持为每个合作伙伴配置自定义 API 域名——请在文档中把该主机名描述为你服务的技术端点。响应中不含任何 LinkProfit 品牌信息：载荷里的域名、短链接和数据分析都属于你的客户自己。
• 由你决定谁能使用。 API 访问权限对应你所售套餐上的 api_access 标志。使用未开启该标志套餐的客户会收到 403 plan_restricted——这正是干净利落的增购时机。速率限制跟随密钥，因此更高档的套餐可以配置更高的限额。

你的文档里应该写什么

一份面向客户的最简开发者页面需要包含四项内容：

1. 密钥在哪里 ——「在你的控制台中打开设置 → API 密钥；密钥只显示一次」。
2. 基础 URL ——https://api.linkprofit.com/v1，使用 Authorization: Bearer <key> 进行认证。
3. 快速上手 ——复制快速上手的内容，把示例中的域名换成你自己的域名。
4. 接口参考 ——链接到交互式接口参考，或者把 OpenAPI 文件（https://linkprofit.com/openapi.json）托管到你自己的文档工具里；它在 Scalar、Swagger UI、Redoc 和 Postman 中都能直接渲染。

面向客户的 Webhook

客户工作区自行注册自己的 Webhook 端点，用于接收短链接、域名和点击量阈值相关的事件。合作伙伴级别的事件——订阅、付款——只留在你的合作伙伴端点上，永远不会投递给客户。

值得说明的限制

• 密钥按工作区划分：管理多个工作区的代理商客户，需要在每个工作区各创建一个密钥。
• 审计日志会把通过 API 发生的变更归因到具体密钥，客户在自己的控制台中就能看到——支持沟通可以直接从事实出发。
• API 写入的一切都遵守与控制台相同的套餐配额：客户无法靠脚本绕过你卖给他们的短链接数量上限。