# REST API for Perfex CRM
## 项目概述
**REST API for Perfex CRM** 是一个为 Perfex CRM 开发的 REST API 模块，基于 CodeIgniter 框架。提供完整的 API 接口，支持第三方系统集成、移动应用开发、Webhook 等功能。
- **版本**: v2.1.4
- **技术栈**: CodeIgniter + PHP
- **API 标准**: RESTful API
- **适用场景**: Perfex CRM 系统集成、移动应用、第三方服务对接
---
## 技术架构
### 核心技术栈
- **框架**: CodeIgniter (基于 Perfex CRM)
- **语言**: PHP
- **API 类型**: RESTful API
- **认证方式**: API Key + Token
- **数据格式**: JSON
### 项目结构
```
api/
├── assets/ # 静态资源
├── config/ # 配置文件
├── controllers/ # API 控制器
├── core/ # 核心扩展
├── helpers/ # 辅助函数
├── language/ # 语言文件
├── libraries/ # 类库
├── migrations/ # 数据库迁移
├── models/ # 模型
├── third_party/ # 第三方库
├── vendor/ # Composer 依赖
├── views/ # 视图模板
├── api.php # 模块入口
├── download_manifest.php # 下载清单
├── download_postman.php # Postman 集合下载
└── install.php # 安装脚本
```
---
## 核心 API 模块
### 1. 认证与授权 (Login & Key)
- **API 登录**: 用户认证登录
- **API Key 管理**: 生成和管理 API 密钥
- **Token 认证**: JWT Token 认证
### 2. 客户管理 (Customers)
- **客户列表**: 获取客户列表
- **客户详情**: 获取客户详细信息
- **创建客户**: 创建新客户
- **更新客户**: 更新客户信息
- **删除客户**: 删除客户
### 3. 联系人管理 (Contacts)
- **联系人列表**: 获取联系人列表
- **联系人详情**: 获取联系人详情
- **创建联系人**: 创建新联系人
- **更新联系人**: 更新联系人信息
- **删除联系人**: 删除联系人
### 4. 线索管理 (Leads)
- **线索列表**: 获取线索列表
- **线索详情**: 获取线索详情
- **创建线索**: 创建新线索
- **更新线索**: 更新线索状态
- **转换线索**: 将线索转换为客户
### 5. 项目管理 (Projects)
- **项目列表**: 获取项目列表
- **项目详情**: 获取项目详情
- **创建项目**: 创建新项目
- **更新项目**: 更新项目信息
- **项目成员**: 管理项目成员
- **项目里程碑**: 管理项目里程碑
### 6. 任务管理 (Tasks)
- **任务列表**: 获取任务列表
- **任务详情**: 获取任务详情
- **创建任务**: 创建新任务
- **更新任务**: 更新任务状态
- **任务评论**: 管理任务评论
- **任务附件**: 管理任务附件
### 7. 发票管理 (Invoices)
- **发票列表**: 获取发票列表
- **发票详情**: 获取发票详情
- **创建发票**: 创建新发票
- **更新发票**: 更新发票信息
- **发票状态**: 更新发票状态
- **发票支付**: 记录发票支付
### 8. 报价单管理 (Estimates)
- **报价单列表**: 获取报价单列表
- **报价单详情**: 获取报价单详情
- **创建报价单**: 创建新报价单
- **更新报价单**: 更新报价单
- **转换发票**: 将报价单转换为发票
### 9. 提案管理 (Proposals)
- **提案列表**: 获取提案列表
- **提案详情**: 获取提案详情
- **创建提案**: 创建新提案
- **更新提案**: 更新提案
- **提案模板**: 管理提案模板
### 10. 合同管理 (Contracts)
- **合同列表**: 获取合同列表
- **合同详情**: 获取合同详情
- **创建合同**: 创建新合同
- **更新合同**: 更新合同
- **合同签名**: 电子签名
### 11. 费用管理 (Expenses)
- **费用列表**: 获取费用列表
- **费用详情**: 获取费用详情
- **创建费用**: 记录新费用
- **更新费用**: 更新费用记录
- **费用分类**: 费用分类管理
### 12. 支付管理 (Payments)
- **支付列表**: 获取支付记录
- **支付详情**: 获取支付详情
- **记录支付**: 记录新支付
- **在线支付**: 集成在线支付
### 13. 贷项通知单 (Credit_notes)
- **贷项单列表**: 获取贷项通知单列表
- **贷项单详情**: 获取贷项单详情
- **创建贷项单**: 创建新贷项单
- **应用到发票**: 将贷项单应用到发票
### 14. 工单管理 (Tickets)
- **工单列表**: 获取工单列表
- **工单详情**: 获取工单详情
- **创建工单**: 创建新工单
- **回复工单**: 回复工单
- **工单状态**: 更新工单状态
- **工单附件**: 管理工单附件
### 15. 员工管理 (Staffs)
- **员工列表**: 获取员工列表
- **员工详情**: 获取员工详情
- **创建员工**: 创建新员工
- **更新员工**: 更新员工信息
- **权限管理**: 管理员工权限
### 16. 工时表 (Timesheets)
- **工时记录**: 获取工时记录
- **记录工时**: 记录新工时
- **工时统计**: 工时统计分析
### 17. 日历管理 (Calendar)
- **日历事件**: 获取日历事件
- **创建事件**: 创建日历事件
- **更新事件**: 更新日历事件
### 18. 订阅管理 (Subscriptions)
- **订阅列表**: 获取订阅列表
- **订阅详情**: 获取订阅详情
- **创建订阅**: 创建新订阅
- **取消订阅**: 取消订阅
### 19. 产品/服务管理 (Items)
- **产品列表**: 获取产品/服务列表
- **产品详情**: 获取产品详情
- **创建产品**: 创建新产品
- **更新产品**: 更新产品信息
### 20. 自定义字段 (Custom_fields)
- **字段列表**: 获取自定义字段
- **字段值**: 获取字段值
- **更新字段**: 更新自定义字段值
### 21. Webhook 管理
- **Webhook 配置**: 配置 Webhook URL
- **事件订阅**: 订阅特定事件
- **Webhook 日志**: 查看 Webhook 发送日志
### 22. 沙盒测试 (Playground)
- **API 测试**: 在线测试 API
- **请求构建**: 构建 API 请求
- **响应查看**: 查看 API 响应
### 23. 统计报告 (Reporting)
- **API 使用统计**: API 调用统计
- **用户统计**: 用户 API 使用情况
- **报告生成**: 生成 API 使用报告
### 24. Zapier 集成 (Zapier)
- **Zapier 连接**: 与 Zapier 集成
- **自动化工作流**: 创建自动化流程
### 25. 第三方集成 (Thirdparty)
- **第三方服务**: 集成第三方服务
... (content truncated)
