文档
API 文档概览
SmartCV API 文档，为开发者提供完整的 REST API 接口说明和使用指南
更新时间: 2024/12/30
SmartCV 提供完整的 REST API，允许开发者集成我们的简历创建和管理功能到第三方应用中。
🚀 API 概览
SmartCV API 基于 REST 架构，使用 JSON 格式进行数据交换，支持标准的 HTTP 方法和状态码。
核心功能
🔐 用户认证
基于 NextAuth.js 的安全认证系统
- OAuth 社交登录
- 邮箱密码认证
- JWT Token 管理
- 会话状态维护
📄 简历管理
完整的简历 CRUD 操作和高级功能
- 创建、编辑、删除简历
- 简历内容管理
- 导出多种格式
- 分享和协作
🎨 模板系统
丰富的简历模板和自定义功能
- 模板列表和分类
- 自定义样式配置
- 预览和应用
- 动态渲染
🤖 AI 服务
强大的 AI 分析和优化功能
- ATS 兼容性分析
- 关键词匹配
- 智能建议生成
- 主题推荐
🔧 快速开始
基础信息
- Base URL:
https://smartcv.cc/api - API 版本: v1
- 数据格式: JSON
- 认证方式: Session Cookie / JWT Token
基本请求格式
GET /api/resumes
Content-Type: application/json
Cookie: next-auth.session-token=<token>响应格式
所有 API 响应都遵循统一的格式：
{
"success": true,
"data": {
// 响应数据
},
"meta": {
// 元数据（可选）
}
}错误响应格式：
{
"error": "错误描述",
"code": "ERROR_CODE"
}📋 API 端点分类
认证相关
- 认证系统 - 用户登录、注册、会话管理
简历管理
- 简历 API - 简历的创建、编辑、删除和查询
模板系统
- 模板 API - 模板管理和自定义
用户管理
- 用户 API - 用户信息和账户管理
AI 功能
- AI 分析 API - ATS 分析、智能建议等 AI 服务
Webhooks
- Webhooks - 事件通知和回调
🔍 状态码说明
| 状态码 | 说明 |
|---|---|
| 200 | 成功 |
| 201 | 创建成功 |
| 400 | 请求参数错误 |
| 401 | 未授权 |
| 403 | 禁止访问 |
| 404 | 资源不存在 |
| 422 | 数据验证失败 |
| 500 | 服务器内部错误 |
🚦 限制说明
请求频率限制
- 免费用户: 100 请求/小时
- 付费用户: 1000 请求/小时
- 企业用户: 无限制
数据限制
- 简历数量:
- 免费用户: 5 份
- 付费用户: 无限制
- 文件上传: 最大 10MB
- API 响应: 最大 1MB
🛠 开发工具
SDK 和示例
我们提供以下开发资源：
测试环境
- 开发环境:
https://dev-api.smartcv.cc - 测试环境:
https://test-api.smartcv.cc - 生产环境:
https://smartcv.cc/api
📞 支持与反馈
如果您在使用 API 过程中遇到任何问题，请联系我们：
- 技术支持: [email protected]
- GitHub Issues: 提交问题