二次开发

把自己的系统接进来,或者直接改源码

两条路都通:不想动源码就走 REST API 与 Webhook;要深度定制就买断源码自己改。 下面 8 篇文档对着真实实现写的,端点、参数、签名算法都能直接对照代码核对。

接入方式

四条路,按你需要改多深来选

大多数集成需求(同步订单、拉报表、推消息)走接口就够了,不需要碰源码。 只有涉及改业务规则、加审批节点、换界面结构,才需要考虑源码级改造。

REST API 800+ 端点,OpenAPI 自动生成

FastAPI 后端自带 /openapi.json,用 Swagger UI 就能在线试调用。统一 {code, msg, data} 信封,offset/limit 分页,JWT Bearer 认证。

管理端 /api/admin/*员工端 /api/h5/*平台总控 /api/platform/*
Webhook 9 类事件回调,秒级触达

一物一码的扫码、表单提交、状态流转、审批、巡检到期都能推到你的系统。HMAC-SHA256 验签,失败按 30×2ⁿ 退避重试三次,另有 10 分钟兜底补偿。

X-Qcode-Signature 验签X-Qcode-Delivery 幂等去重投递日志可查每一条
认证 JWT 认证,可接企业账号体系

token 内含 user_id 与 tenant_id,服务端逐请求校验租户归属。三种接入方式:代理换 token、账号同步 + 门户跳转、私有化改源码接 OIDC。

55 个权限点做细粒度控制租户隔离由服务端强制登录限流 5 分钟 10 次
源码 私有化买断版交付源码

Python / FastAPI + SQLAlchemy 2.0 + Alembic + Celery,前端 Vue 3 + Vite + Element Plus。分层清晰,加接口加字段都有固定路径,不靠猜。

含数据库迁移脚本前端菜单/路由/权限三处对应支持二次开发与接口文档
文档清单

8 篇,从调通第一个接口到安全升级

建议按顺序读前两篇(快速开始 → 订单同步),其余按需求跳读。 每篇都有可复制的代码,域名和密钥换成你自己的就能跑。

01

API 快速开始:认证、响应格式、分页与错误码

系统对外暴露 800+ 个 REST 端点,OpenAPI 文档在 /openapi.json。先搞清四件事:怎么拿 token、响应长什么样、怎么翻页、错误怎么判。

12 分钟·入门· 3 段代码
02

订单同步对接:把外部订单自动拉进系统

最常见的集成需求:客户在商城/ERP 下单,自动进本系统变成生产订单。难点不在调接口,在幂等、对照表和失败重试。

14 分钟·进阶· 1 段代码
03

Webhook 回调:扫码、表单提交、状态变更实时通知

一物一码模块支持对外 webhook。相比轮询,回调能做到秒级,但必须自己处理签名校验、重试、乱序三件事。

13 分钟·进阶· 2 段代码
04

认证与 SSO:把本系统接进你的账号体系

目前是 JWT Bearer,没有内置的 OIDC/SAML。要做单点登录有两种做法:前置代理换 token,或改源码接 IdP。

11 分钟·进阶· 1 段代码
05

数据导出与 BI 对接:把数拉到你自己的看板

系统里的报表够日常用,但老板可能想在帆软/PowerBI 里看。两条路:调接口拉数据,或私有化直连数据库。

11 分钟·进阶· 2 段代码
06

后端源码二次开发:加接口、加字段、加迁移

FastAPI + SQLAlchemy 2.0 + Alembic 的分层结构。改之前先搞清五个目录各自负责什么,否则改一处崩三处。

15 分钟·进阶· 2 段代码
07

管理端前端二次开发:加页面、加菜单、加权限点

Vue 3 + Vite + Element Plus。三处必须同步改:路由、菜单、权限点。少改一处就会出现「页面能进但菜单没有」或「菜单点了 403」。

13 分钟·进阶· 3 段代码
08

数据库迁移与版本升级:别让升级变成事故

升级出问题,九成是没有备份、或者跳过了迁移检查。这两件事做到,剩下都是可恢复的小问题。

14 分钟·进阶· 1 段代码
技术栈

你会看到什么代码

后端

  • Python 3.11 + FastAPI(OpenAPI 自动生成)
  • SQLAlchemy 2.0 + Alembic(迁移必须走脚本)
  • Pydantic v2(请求/响应模型)
  • Celery + Redis(异步任务与定时任务)
  • MySQL 8(业务库)、ChromaDB(AI 知识库)

前端

  • Vue 3 + Vite + TypeScript
  • Element Plus(组件库)
  • Vue Router(路由 meta 声明权限)
  • vue-i18n(菜单与文案,中英双语)
  • 微信小程序 + H5(员工端与客户端)
关于「不改源码能不能做」 —— 能。同步订单、拉取报表、接收扫码事件、嵌入看板,这四类需求都不需要源码。 需要改源码的典型场景是:改审批规则、加自定义字段且要参与计算、换掉某个页面的交互结构。 买断版含源码与接口文档,可以自己改;年授权版提供接口层定制服务。

要一份接口对接方案?

说清你要接什么系统、同步什么数据,我们给一页纸的方案。