My Backlink

API 文档 — 自动化你的外链管理

通过 REST API 将 My Backlink 集成到你的工作流。使用 API Key 认证，查询平台、管理外链和项目，支持浏览器插件和自动化脚本接入。

API Key 管理

使用 API 前需要先创建 API Key。每个 API Key 以 mlv_ 为前缀，可设置过期时间。创建后请妥善保管，Key 仅在创建时完整显示一次。

创建 API Key

进入控制台的「设置」或「API Key」页面，点击「创建 API Key」。填写 Key 名称（用于标识用途，如「浏览器插件」、「自动化脚本」等），可选设置过期时间。创建成功后立即复制并安全保存完整的 Key —— 后续仅显示部分遮蔽的 Key。你可以随时删除不再需要的 API Key。

认证方式

所有需要认证的 API 端点使用 Bearer Token 方式。将你的 API Key 放入请求头的 Authorization 字段。

请求头格式

Authorization: Bearer mlv_your_api_key_here

请勿将 API Key 硬编码在前端代码或公开仓库中。建议使用环境变量或安全的密钥管理方案存储 Key。

API 端点列表

搜索平台

GET/api/v1/platforms

查询平台库数据，支持按分类筛选和分页。这是公开端点，无需 API Key 认证。可用参数：category（平台分类）、page（页码）、limit（每页数量，最大 100）。

获取用户项目

GET/api/v1/user/projects需要认证

获取当前认证用户的所有项目列表，返回项目名称、URL、Tagline 等基本信息。

获取用户外链

GET/api/v1/user/links需要认证

查询当前用户的外链记录，支持按项目和平台筛选，以及分页。可用参数：projectId、platformId、page、limit。返回外链详情及关联的平台和项目信息。

创建外链

POST/api/v1/user/links需要认证

为当前用户创建一条新的外链记录。必填字段：url（链接地址）、title（标题）。可选字段：description、platformId、projectId、anchorText、notes、tags。

获取用户信息

GET/api/v1/user/profile需要认证

获取当前认证用户的基本信息，包括 ID、名称、邮箱和角色。可用于验证 API Key 是否有效。

AI 辅助生成提交内容

GET/api/v1/ai/generate-submission需要认证

根据指定的外链记录（linkId），结合项目资料和平台表单字段，生成 AI 辅助的提交内容建议。返回提示词和上下文数据（项目、平台、字段定义、已有示例）。

文件上传

POST/api/v1/upload需要认证

上传图片文件（JPEG、PNG、WebP、GIF、SVG，最大 5MB）。通过 FormData 发送，指定 file（文件）、type（logo 或 screenshot）和可选的 projectId。返回文件的访问 URL 和存储 Key。

分页与筛选

列表类端点支持分页参数：page（页码，从 1 开始）和 limit（每页数量，默认 20，最大 100）。响应中包含 pagination 对象，提供 total（总数）、page、limit 和 totalPages 信息。部分端点支持额外的筛选参数，如 category、projectId、platformId 等。

GET /api/v1/platforms?page=1&limit=20&category=ai-tools

集成提示

平台搜索端点（/api/v1/platforms）无需认证即可调用，适合在浏览器插件中使用。对于需要操作用户数据的端点，建议在服务端调用以保护 API Key 安全。