权限管理系统

完整的API接口文档 - Express.js + Electron

23
功能模块
202
API接口
1.0.0
版本号

公共请求头(所有接口适用)

参数名 必填 类型 示例 说明
Authorization string Bearer <JWT token> 用户登录后的 JWT 令牌。若已登录可直接使用,无需传 X-Client。。认证 Token,请在请求头中携带,推荐格式:Bearer {token}
X-Client string <client key token> 客户端密钥。当未携带或无法使用 Authorization 时必填,用于密钥认证。线上文档: http://localhost:5601/docs
X-Site string <site key> 站点标识(必填)。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。
X-System-Code string AUTH_MANAGEMENT 系统编码(必填)。用于指定当前访问的业务系统(例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT)。当系统不支持时将返回“登录用户不支持当前系统,可联系管理员处理”。

API响应码列表

共 45 个响应码
API响应码说明。所有接口统一返回HTTP 200状态码,业务状态通过响应体中的code字段表示。 点击展开

成功响应码 (1个)

参数名 必填 类型 示例 说明
0000 string 操作成功 请求处理成功,这是所有成功响应的标准代码

错误响应码 (44个)

参数名 必填 类型 示例 说明
1001 string 缺少令牌 请求中缺少必要的令牌(访问令牌、登录令牌、注册令牌等)
1002 string 令牌无效或已过期 提供的令牌格式错误、无法解析、已过期或信息不完整
1003 string 会员不存在 指定的会员记录在系统中不存在
1004 string 会员状态无效 会员状态不是有效状态(非启用状态)
1005 string 会员已过期 会员的有效期已过
1006 string 系统未开放或已停用 请求的系统代码对应的系统未启用、不存在或已被停用
1007 string 会员类型未授权当前系统 当前会员类型未配置访问该系统的权限,或会员码不支持当前系统
1008 string 系统模块未开放访问 请求的系统模块未启用或不存在
1009 string 会员未开通该功能模块 会员未开通请求的功能模块
1010 string 当前模块的使用已达到上限 模块使用次数已达到配置的上限值
1103 string 账号已被加入黑名单 账号已被加入黑名单,无法执行操作或登录
1104 string 会员类型不存在或已停用 指定的会员类型不存在或已被停用
1105 string 订单不存在 指定的订单记录在系统中不存在
1106 string 订单手机号与当前账号不匹配 订单关联的手机号与当前登录账号的手机号不一致
1107 string 订单尚未支付或已失效 订单状态不是已支付或已完成状态
1108 string 订单类型与会员类型不匹配 订单的会员类型与请求的会员类型不一致
1109 string 管理员角色未配置 系统中未找到管理员角色配置
1201 string 密码需包含字母和数字,且不少于6位 密码不符合要求:必须包含字母和数字,且长度不少于6位(适用于注册和登录)
1202 string 手机号已注册系统用户 该手机号已被注册为系统用户
1203 string 公司信用代码已注册 该公司信用代码已被注册
1204 string 手机号已注册客户端用户 该手机号已被注册为客户端用户
1210 string 站点标识生成失败,请稍后重试 生成站点标识时发生错误
1211 string 拒绝无效访问 站点标识无效或访问被拒绝
1303 string 请同意隐私等协议 散客账号登录时必须同意隐私协议
1304 string 账号或密码错误 登录时提供的账号或密码不正确
1306 string 用户未启用或已过期 用户状态不是启用状态,或用户有效期已过(适用于系统用户和客户端用户)
1401 string 用户不存在 指定的用户记录在系统中不存在(适用于系统用户和客户端用户)
1403 string 不支持当前系统, 可联系管理员处理 当前账号不支持访问该系统,需要联系管理员处理
1500 string 接口标识不能为空 / 缺少会员密钥 / 会员密钥无效 请求中缺少会员密钥,或会员密钥格式错误、无法解析
1501 string 接口未授权或未在系统中配置 / 激活已超时,请重新绑定激活 接口未授权或未在系统中配置,或激活操作已超时需要重新绑定
1502 string 缺少必要权限 账号缺少访问资源所需的权限
1504 string 您绑定的会员码无效 绑定的会员码不存在、状态无效、会员类型无效或已过期
1505 string 传入的会员需要重新绑定 会员密钥已过期,需要重新绑定激活
1508 string 当前会员不支持当前功能 会员未开通请求的功能模块
1509 string 缺少功能代码 请求中缺少必要的功能代码参数
1999 string 权限校验失败 权限校验过程中发生未预期的错误
400 string 请求参数错误 / 参数验证失败 请求参数格式错误或验证失败
401 string 未授权访问 / 令牌无效 / 令牌已过期 / 登录失败,用户名或密码错误 未授权访问,令牌无效或已过期,或登录凭据错误
403 string 禁止访问 账号没有权限访问该资源
404 string 资源不存在 请求的资源在系统中不存在
405 string 此接口仅支持 POST 方法,请使用 POST 请求 请求方法不正确,该接口仅支持POST方法
409 string 资源冲突 / 数据已存在 创建的资源已存在,或数据冲突
429 string 请求过于频繁,请稍后再试 请求频率超过限制,需要稍后重试
500 string 操作失败 / 服务器内部错误 / 数据库操作失败 服务器内部错误,操作失败或数据库操作异常
查看所有模块