Skip to main content

API 管理

Cloud CMS 提供完整的内容 API，支持与其他系统集成，实现内容分发和数据同步。

API 密钥管理​

创建 API 密钥​

  1. 进入 API 管理 页面
  2. 点击「新增密钥」
  3. 输入密钥名称和描述
  4. 设置权限范围
  5. 保存生成密钥

::: danger 密钥安全 API 密钥生成后只会显示一次，请立即复制并妥善保存。 不要将密钥提交到代码仓库或公开场合，避免数据泄露。 :::

密钥权限​

  • 只读：仅允许查询内容
  • 读写：允许创建、修改和删除内容

密钥管理操作​

  • 编辑：修改密钥名称和描述
  • 刷新：生成新的密钥值（旧密钥立即失效）
  • 删除：永久禁用该密钥

API 使用说明​

认证方式​

所有 API 请求都需要在请求头中携带 API 密钥：

X-API-Key: 您的API密钥

内容查询​

通过 API 可以获取：

  • 文章列表和详情
  • 分类信息
  • 站点配置
  • 媒体资源信息

适用场景​

  • 手机 App 内容展示
  • 小程序内容接入
  • 多站点内容同步
  • 第三方系统集成
  • 数据备份和导出

使用建议​

安全最佳实践​

✅ 定期轮换 API 密钥
✅ 为不同用途创建独立密钥
✅ 遵循最小权限原则
✅ 监控 API 使用情况
✅ 发现泄露立即刷新或删除密钥

性能优化建议​

  • 合理使用缓存减少 API 调用
  • 避免频繁的大批量数据请求
  • 在业务低峰期进行数据同步

常见问题​

Q: API 请求有限制吗？
A: 有合理的频率限制，正常业务使用不会受到影响。

Q: 密钥丢失怎么办？
A: 可以在 API 管理中刷新密钥，获取新的密钥值。

Q: 可以创建多个 API 密钥吗？
A: 可以，建议为不同的应用场景创建独立的密钥。