Open API 概览

接口地址:
- POST /api/v1/ai/chat/completions - 对话补全
- POST /api/v1/ai/images/generations - 图片生成
使用场景:
- AI 聊天机器人
- 内容生成
- 图片创作和编辑
- 创意自动化
- 智能助手

查看 AI API 文档 →

访问交互式调试器 →

快速开始

1. 创建 API 密钥

在使用任何 API 接口之前，您需要创建一个 API 密钥：

登录您的 LikeDo 账户
导航到 设置 > API 密钥
点击 创建 API 密钥
根据您的套餐配置速率限制
安全保存您的 API 密钥（仅显示一次）

2. 身份认证

所有 API 请求都需要使用您的 API 密钥进行身份验证。您可以通过两种方式提供 API 密钥：

方式 1: Authorization 请求头（推荐）

Authorization: Bearer YOUR_API_KEY

方式 2: 查询参数

?key=YOUR_API_KEY

3. 速率限制

速率限制根据您的订阅套餐自动配置：

套餐	速率限制
免费版	200 请求/小时
Pro 版	2000 请求/小时
终身版	2000 请求/小时

速率限制信息包含在响应头中：

X-RateLimit-Limit: 每小时允许的总请求数
X-RateLimit-Remaining: 当前时间窗口中剩余的请求数
X-RateLimit-Reset: 速率限制重置的时间戳

API 响应格式

所有 API 接口都返回 JSON 格式的响应，具有一致的结构：

成功响应

{
  "success": true,
  "data": {
    // 接口特定的响应数据
  }
}

错误响应

{
  "success": false,
  "error": "描述错误的消息",
  "details": [
    // 可选：验证错误数组或其他详细信息
  ]
}

HTTP 状态码

我们的 API 使用标准的 HTTP 状态码：

状态码	含义
200	OK - 请求成功
201	Created - 资源成功创建
400	Bad Request - 请求数据无效
401	Unauthorized - API 密钥缺失或无效
403	Forbidden - API 密钥有效但权限不足
409	Conflict - 资源已存在
429	Too Many Requests - 超出速率限制
500	Internal Server Error - 服务器内部错误

最佳实践

安全性

保护 API 密钥安全: 永远不要将 API 密钥提交到版本控制系统
使用环境变量: 将密钥存储在 .env 文件或安全保险库中
定期轮换密钥: 定期生成新密钥以增强安全性
使用 HTTPS: 始终通过安全连接发起请求
监控使用情况: 定期在控制台查看 API 密钥使用情况

性能

实现重试逻辑: 使用指数退避处理临时故障
缓存响应: 在适当的情况下缓存 API 响应以减少请求
批量操作: 如果创建多个资源，考虑间隔开请求
监控速率限制: 跟踪您的使用情况以避免达到限制
使用 Webhooks: 对于实时更新，考虑使用 webhooks 而不是轮询

错误处理

async function createShortLink(data) {
  try {
    const response = await fetch('/api/v1/links/create', {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${process.env.API_KEY}`,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify(data),
    });

    const result = await response.json();

    if (!response.ok) {
      // 处理不同的错误场景
      if (response.status === 401) {
        throw new Error('API 密钥无效');
      } else if (response.status === 429) {
        throw new Error('超出速率限制，请稍后重试');
      } else {
        throw new Error(result.error || '请求失败');
      }
    }

    return result.data;
  } catch (error) {
    console.error('API 错误:', error);
    throw error;
  }
}

API 调试器

在将 API 集成到您的应用程序之前，可以通过交互式调试器进行测试：

短链接调试器: /ing/short-link
文章调试器: /ing/post
邮箱调试器: /ing/email
AI 调试器: /ing/ai

调试器允许您：

使用自己的 API 密钥测试接口
查看实时的请求和响应数据
复制多种编程语言的代码示例
在实现之前了解 API 行为

技术支持

需要 API 帮助？

文档: 浏览我们全面的 API 文档
示例: 查看多种编程语言的代码示例
社区: 加入我们的社区进行讨论和支持
联系我们: 联系我们的支持团队获取技术帮助

即将推出

我们正在不断扩展 API 功能。敬请期待：

Webhook API: 链接点击和事件的实时通知
分析 API: 详细的统计数据和洞察
域名管理 API: 编程式域名配置
文件存储 API: 通过 API 上传和管理文件

更新日志

在我们的更新日志中跟踪 API 更新和变更。

介绍

可用的 API

LikeDo 目前提供以下 API 接口：

1. 短链接 API

通过编程方式创建和管理品牌短链接。

接口地址: POST /api/v1/links
使用场景:
- 社交媒体工具中的自动化链接缩短
- 动态二维码生成
- 营销活动追踪和分析
- 批量创建链接
- 营销自动化集成

查看短链接 API 文档 →

访问交互式调试器 →

2. 文章 API

通过编程方式创建和管理博客文章，支持 AI 功能。

接口地址: POST /api/v1/posts
使用场景:
- 自动化内容发布
- 博客管理系统
- 内容调度工作流
- 多站点内容分发
- AI 辅助内容创作

查看文章 API 文档 →

访问交互式调试器 →

3. 邮箱 API

通过编程方式在您的域名上创建自定义邮箱地址。

接口地址: POST /api/v1/emails
使用场景:
- 自动化邮箱地址配置
- 用户注册流程
- 临时邮箱创建
- 邮箱管理系统
- 多租户应用程序

查看邮箱 API 文档 →

访问交互式调试器 →

4. AI API

访问兼容 OpenAI 的 AI 接口，用于对话和图片生成。

接口地址:
- POST /api/v1/ai/chat/completions - 对话补全
- POST /api/v1/ai/images/generations - 图片生成
使用场景:
- AI 聊天机器人
- 内容生成
- 图片创作和编辑
- 创意自动化
- 智能助手

查看 AI API 文档 →

访问交互式调试器 →

快速开始

1. 创建 API 密钥

在使用任何 API 接口之前，您需要创建一个 API 密钥：

登录您的 LikeDo 账户
导航到 设置 > API 密钥
点击 创建 API 密钥
根据您的套餐配置速率限制
安全保存您的 API 密钥（仅显示一次）

2. 身份认证

所有 API 请求都需要使用您的 API 密钥进行身份验证。您可以通过两种方式提供 API 密钥：

方式 1: Authorization 请求头（推荐）

Authorization: Bearer YOUR_API_KEY

方式 2: 查询参数

?key=YOUR_API_KEY

3. 速率限制

速率限制根据您的订阅套餐自动配置：

套餐	速率限制
免费版	200 请求/小时
Pro 版	2000 请求/小时
终身版	2000 请求/小时

速率限制信息包含在响应头中：

X-RateLimit-Limit: 每小时允许的总请求数
X-RateLimit-Remaining: 当前时间窗口中剩余的请求数
X-RateLimit-Reset: 速率限制重置的时间戳

API 响应格式

所有 API 接口都返回 JSON 格式的响应，具有一致的结构：

成功响应

{
  "success": true,
  "data": {
    // 接口特定的响应数据
  }
}

错误响应

{
  "success": false,
  "error": "描述错误的消息",
  "details": [
    // 可选：验证错误数组或其他详细信息
  ]
}

HTTP 状态码

我们的 API 使用标准的 HTTP 状态码：

状态码	含义
200	OK - 请求成功
201	Created - 资源成功创建
400	Bad Request - 请求数据无效
401	Unauthorized - API 密钥缺失或无效
403	Forbidden - API 密钥有效但权限不足
409	Conflict - 资源已存在
429	Too Many Requests - 超出速率限制
500	Internal Server Error - 服务器内部错误

最佳实践

安全性

保护 API 密钥安全: 永远不要将 API 密钥提交到版本控制系统
使用环境变量: 将密钥存储在 .env 文件或安全保险库中
定期轮换密钥: 定期生成新密钥以增强安全性
使用 HTTPS: 始终通过安全连接发起请求
监控使用情况: 定期在控制台查看 API 密钥使用情况

性能

实现重试逻辑: 使用指数退避处理临时故障
缓存响应: 在适当的情况下缓存 API 响应以减少请求
批量操作: 如果创建多个资源，考虑间隔开请求
监控速率限制: 跟踪您的使用情况以避免达到限制
使用 Webhooks: 对于实时更新，考虑使用 webhooks 而不是轮询

错误处理

async function createShortLink(data) {
  try {
    const response = await fetch('/api/v1/links/create', {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${process.env.API_KEY}`,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify(data),
    });

    const result = await response.json();

    if (!response.ok) {
      // 处理不同的错误场景
      if (response.status === 401) {
        throw new Error('API 密钥无效');
      } else if (response.status === 429) {
        throw new Error('超出速率限制，请稍后重试');
      } else {
        throw new Error(result.error || '请求失败');
      }
    }

    return result.data;
  } catch (error) {
    console.error('API 错误:', error);
    throw error;
  }
}

API 调试器

在将 API 集成到您的应用程序之前，可以通过交互式调试器进行测试：

短链接调试器: /ing/short-link
文章调试器: /ing/post
邮箱调试器: /ing/email
AI 调试器: /ing/ai

调试器允许您：

使用自己的 API 密钥测试接口
查看实时的请求和响应数据
复制多种编程语言的代码示例
在实现之前了解 API 行为

技术支持

需要 API 帮助？

文档: 浏览我们全面的 API 文档
示例: 查看多种编程语言的代码示例
社区: 加入我们的社区进行讨论和支持
联系我们: 联系我们的支持团队获取技术帮助

即将推出

我们正在不断扩展 API 功能。敬请期待：

Webhook API: 链接点击和事件的实时通知
分析 API: 详细的统计数据和洞察
域名管理 API: 编程式域名配置
文件存储 API: 通过 API 上传和管理文件

更新日志

在我们的更新日志中跟踪 API 更新和变更。

目录

Open API 概览

目录