Skip to content

新增邀请码

1. 接口定位

  • 接口名称: 新增邀请码
  • 所属域: admin/invitation-code
  • 业务目标: 批量写入自定义邀请码,供注册流程按配置启用时校验使用

2. 请求定义

  • Method: POST
  • Path: /invitation_code/add
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 非幂等;重复提交同一批邀请码会因为已存在而失败

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
codesarray<string>要新增的邀请码列表,允许批量

字段约束

  • codes 在协议校验层不能为空数组或 null
  • RPC 层还会再次校验 codes 长度必须大于 0
  • codes 中不允许出现重复值,否则返回 codes is duplicate
  • 每个邀请码必须在数据库中尚不存在,否则返回已存在的邀请码列表。

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataobject业务数据

data 字段

  • 本接口成功时返回空对象(无业务字段)。

5. 业务规则

  • 仅管理员可以调用。
  • 服务端会先查询 codes 是否已存在于 invitation_register 集合。
  • 新增成功后,每条记录会写入:
    • invitationCode: 邀请码本身
    • usedUserID: 空字符串,表示未使用
    • createTime: 当前服务端时间
  • 本接口只负责写入邀请码,不会触发任何注册流程。

6. 错误码与失败场景

错误码场景典型报错
1001codesnullcodes is invalid
1001codes 为空数组codes is empty
1001codes 内存在重复值codes is duplicate
1001部分邀请码已存在code existed
-数据库唯一索引冲突或写入失败由数据库层返回原始错误
-token 非管理员或无效由鉴权中间件/管理员校验返回

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/invitation_code/add", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440401",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    codes: ["WELCOME2026", "BETA-USER-001"],
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "codes": ["WELCOME2026", "BETA-USER-001"]
}

成功响应示例

json
{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

失败响应示例

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "codes is duplicate"
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 校验 codes 基础格式是否合法。
  3. 查询数据库,确认待新增邀请码没有与现存记录冲突。
  4. 生成带 createTime 的邀请码记录并批量写入数据库。
  5. 返回统一成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于邀请码新增的真实校验与落库逻辑补全文档。