API 说明

云枢 ERP 前后端同构——你在界面上看到的每个功能，背后都是一套 RESTful API。私有化部署后，你可以用同一套 API 做二次开发、对接自有系统（小程序、官网、机器人等）。

01基本信息

项	值
基础地址	`https://你的域名/erp/api/v1`
风格	RESTful + JSON
鉴权	JWT Bearer Token（登录接口签发）
规范	OpenAPI 3.0（部署内网可访问 `/erp/api/docs` 交互式文档）

安全默认：交互式 Swagger 不对公网开放，仅在部署内网/本机可用；公网只暴露业务接口且全部要求鉴权。

02鉴权方式

登录后获得 Token，后续请求携带在 Authorization 头：

POST /erp/api/v1/auth/login
{ "username": "demo", "password": "******" }

# 返回
{ "access_token": "eyJhbGciOi...", "token_type": "bearer" }

# 后续请求
curl -H "Authorization: Bearer <token>" \
     https://你的域名/erp/api/v1/stores

所有接口按「权限码」双重校验：Token 合法 + 角色具备该端点权限码，缺一返回 401/403。

03端点分组一览

分组	前缀示例	说明
认证与用户	`/auth /users /roles`	登录、邀请、角色权限码、租户管理
店铺与商品	`/stores /products`	多平台店铺、商品同步、生意参谋数据
AI 能力	`/advice /ai-monitor`	店铺诊断日报、建议反馈、规则知识库
单据中心	`/sales /purchase /inventory /fund`	9 类单据 CRUD 与审核流
报表分析	`/reports /transaction-analysis`	库存统计、交易分析、驾驶舱聚合
获客引擎	`/crawler /leads`	采集任务、线索库、enrichment 流水线
运营任务	`/ops /notify`	任务看板、状态流转、钉钉/企微推送
内容工厂	`/content /media`	文案、配音、出图、视频生成

04对接建议

微信小程序 / 自有网站 → 直接调 REST 接口（示例：国庆头像小程序即接本系统）；
钉钉/企微机器人 → 由系统主动推送，无需拉取；
批量导入导出 → 优先用「数据导出」模块的 CSV/快照能力，避免高频单条调用。

需要完整接口清单与字段文档，部署时随系统提供（内网 Swagger 全量可导出 OpenAPI JSON）。