Skip to content

开放 API ​

对外与对内 HTTP 能力:平台 Controller + 接口引擎自定义路由。

功能说明 ​

前缀:/api/{code}/v1(以及接口表中的自定义 route)。

方法路由名称
POST/api/code/v1/login账号登录
GET/api/code/v1/departmenu/context部门组织
GET/api/code/1/tool雪花生成
GET/api/code/v1/spaces文档空间
GET/api/code/v1/user我的资料
GET/api/code/v1/department/users部门成员
DELETE/api/code/v1/deparment/{deparment_id}/user/{user_id}移除成员
GET/api/code/v1/file/{id}下载地址
POST/api/code/v1/department/{department_id}/users加入部门
GET/api/code/v1/folder/content目录列表
POST/api/code/v1/file文件上传
GET/api/code/v1/role/{role_id}/users角色成员
GET/api/code/v1/user-roles我的角色
GET/api/v1/smart-link/wx/qrcode扫码登录
GET/api/v1/smart-link/wechat/status扫码状态
GET/api/v1/code/ribbon插件配置
GET/api/crm/v1/users全部用户
GET/api/code/v1/audit-logs审计日志
GET/api/code/v1/audit-log/{id}审计详情
GET/api/code/v1/error-logs错误日志
GET/api/code/v1/error-log/{id}错误详情
GET/api/code/v1/authorization-logs登录日志
GET/api/code/v1/authorization-log/{id}登录详情
POST/api/code/v1/message/test-send-site站内测试
POST/api/code/v1/message/test-send-email邮件测试
POST/api/code/v1/message/test-send-sms短信测试
GET/api/code/v1/message消息角标
GET/api/code/v1/messages消息面板
GET/api/code/v1/message/{id}标记已读
GET/api/code/v1/space/manage/list空间管理列表

原理 ​

平台 API 经 Controller→Logic;自定义 API 经接口引擎脚本。均需鉴权(除非匿名)。

名词解释 ​

名词说明
BearerJWT 访问令牌
站点码

属性说明 ​

来源如何扩展
Controller加 Action + Logic
接口引擎加 t_interface 行

示例 ​

http
GET /api/code/v1/user
Authorization: Bearer <token>

相关文档 ​

白泽 ProCode 开发者文档