平台对接文档
联系我们
联系我们
  • api 对接流程(必看)
  • api 认证
  • api 接口

Api API 文档(商户开放 API)

目录

  1. 用户 User
  2. 验证码 Captcha
  3. 文件上传 OSS
  4. 其他
  5. 附:路由一览表

1. 用户 User

POST /api/v1/user-create — 创建用户

请求体(JSON):

{
    "username": "a123456",
    "app_ids": [1,2,3,4]
}
字段类型必填示例说明
usernamestring✅a123456用户名,小写字母开头,不含特殊字符,不能超过20位字符
app_idsid列表-[1,2,3,4]授权应用 ID 列表, 从 /api/v1/all-apps 中获取

响应 data:

{
  "code": 200,
  "message": "成功"
}

2. 验证码 Captcha

控制器:CaptchaController

GET /api/v1/captcha — 获取图形验证码

  • 限流:Limit.CaptchaRate
  • 逻辑:gokit.Captcha().Generate();App.Debug 模式下验证码答案打印到 stdout
  • 响应 data:
{ "captcha_id": "<id>", "captcha_image": "<base64 图片>" }

Prev
api 认证