开发者

API 文档

面向开发者的 RESTful API 接口文档。通过 API 与星云 CRM 进行数据集成和自动化操作。

快速开始

接入 API 的基本步骤

1

获取 API 密钥

暂未开通

2

鉴权获取 Token

暂未开通

3

调用业务接口

暂未开通

接口模块

覆盖所有核心业务模块

👤

客户管理 API

客户的增删改查、批量操作、联系人管理等接口。

查看详情 →

🎯

线索管理 API

线索创建、认领、跟进、转化等全流程接口。

查看详情 →

💰

商机管理 API

商机创建、阶段推进、赢单输单等接口。

查看详情 →

📝

跟进记录 API

跟进记录的创建、查询、附件上传等接口。

查看详情 →

📄

合同管理 API

合同创建、审批、关联回款与发票等接口。

查看详情 →

💳

财务管理 API

回款记录、发票管理、OCR 识别等接口。

查看详情 →

📦

产品管理 API

产品目录、价格体系、库存管理等接口。

查看详情 →

🏗️

项目管理 API

项目立项、需求管理、里程碑等接口。

查看详情 →

🎫

工单管理 API

工单创建、分配、处理、关闭等接口。

查看详情 →

通用说明

通用规范

• 协议：所有接口使用 HTTPS
• 格式：请求和响应均为 JSON 格式
• 分页：page（页码，从 1 开始）和 size（每页条数，默认 20，最大 100）
• 排序：sort（排序字段）和 order（asc/desc）
• 频率限制：单应用 60 次/分钟

注意事项

• Access Token 有效期为 2 小时，过期后需重新获取
• 敏感操作（删除、批量修改）需要管理员权限
• 建议在服务端调用 API，避免在前端暴露 App Secret

错误码

错误码	说明	处理方式
200	成功	—
400	参数错误	检查请求参数格式
401	未授权	重新获取 Token
403	权限不足	检查应用权限配置
404	资源不存在	检查资源 ID
429	请求频率超限	降低调用频率
500	服务器错误	联系技术支持