API 参考
完整的 RESTful API 接口文档
认证方式
所有 API 请求需在 Header 中携带 JWT Bearer Token：
Authorization: Bearer <your_token>Token 通过 POST /api/v1/auth/login 获取，有效期 24 小时。
表单管理
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/v1/portal/forms | 获取表单列表 |
| GET | /api/v1/portal/forms/:id | 获取表单详情 |
| POST | /api/v1/portal/forms | 创建表单 |
| PUT | /api/v1/portal/forms/:id | 更新表单 |
| DELETE | /api/v1/portal/forms/:id | 删除表单 |
| POST | /api/v1/portal/forms/:id/publish | 发布表单 |
| POST | /api/v1/portal/forms/import | 导入表单 Schema |
| GET | /api/v1/portal/forms/:id/export | 导出表单 Schema |
表单数据
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /api/v1/portal/instances | 提交表单数据 |
| GET | /api/v1/portal/instances | 查询实例列表（支持 JSONB 筛选） |
| GET | /api/v1/portal/instances/:id | 获取实例详情 |
| GET | /api/v1/portal/instances/export | 导出表单数据（CSV/Excel） |
| POST | /api/v1/portal/instances/:id/contributions | 协作填写贡献 |
工作流
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/v1/portal/workflows/todo | 获取待办列表 |
| POST | /api/v1/portal/workflows/:id/approve | 审批通过 |
| POST | /api/v1/portal/workflows/:id/reject | 审批驳回 |
| POST | /api/v1/portal/workflows/:id/transfer | 转交审批 |
| GET | /api/v1/portal/workflows/:id/trace | 获取审批轨迹 |
团队
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/v1/portal/teams | 获取团队列表 |
| POST | /api/v1/portal/teams | 创建团队 |
| POST | /api/v1/portal/teams/:id/members | 邀请成员 |
| PUT | /api/v1/portal/teams/:id/members/:uid | 更新成员角色 |
| DELETE | /api/v1/portal/teams/:id/members/:uid | 移除成员 |
模板
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/v1/portal/templates | 获取模板列表 |
| GET | /api/v1/portal/templates/:id | 获取模板详情 |
| POST | /api/v1/portal/templates | 发布为模板 |
| POST | /api/v1/portal/templates/:id/use | 从模板创建表单 |
错误码
| 状态码 | 说明 |
|---|---|
| 400 | 请求参数错误 |
| 401 | 未认证或 Token 过期 |
| 403 | 无权限访问 |
| 404 | 资源不存在 |
| 409 | 资源冲突（如重复提交） |
| 422 | Schema 校验失败 |
| 429 | 请求频率超限 |
| 500 | 服务器内部错误 |
速率限制
API 请求默认限制为每分钟 60 次。超出限制时返回 429 状态码。企业版客户可享受更高的速率限制，请联系客户经理了解详情。
X-RateLimit-Limit: 60 X-RateLimit-Remaining X-RateLimit-Reset