用户API文档

本文档描述了用户相关的API接口，包括用户注册、登录和验证码获取等功能。

1. 用户注册

用户注册

创建新用户账户。需要提供用户名、密码和验证码信息。

POSThttps://xrobo.qiniu.com/xiaozhi/user/register

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/xiaozhi

Method:POST

返回类型:application/json

请求参数

参数名类型必填位置说明

usernamestring是-用户名

passwordstring是-用户密码

captchastring是-图形验证码

mobileCaptchastring否-手机验证码

captchaIdstring是-验证码ID

请求头

Header名类型必填说明

Content-Type是请求内容类型

请求示例

{
  "username": "example",
  "password": "password",
  "captcha": "ABCD",
  "mobileCaptcha": "123456",
  "captchaId": "cfa94872-48b6-425b-8e6a-17b912b6b6f4"
}

响应示例

{
  "code": 0,
  "msg": "注册成功",
  "data": {}
}

状态码

0注册成功

400请求参数错误

409用户名已存在

500服务器内部错误

2. 获取验证码

获取图形验证码

获取用于注册和登录的图形验证码。返回PNG格式的验证码图片。

GEThttps://xrobo.qiniu.com/xiaozhi/user/captcha

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/xiaozhi

Method:GET

返回类型:application/json

请求参数

参数名类型必填位置说明

uuidstring是-随机生成的UUID

状态码

0成功返回验证码图片

400UUID参数错误

500服务器内部错误

提示

UUID需要随机生成，建议使用标准的UUID v4格式。验证码图片为PNG格式，需要用户识别并输入验证码内容。

3. 用户登录

用户登录

用户登录认证。成功后返回访问令牌，该令牌用于后续API调用的身份验证。

POSThttps://xrobo.qiniuapi.com/xiaozhi/user/login

点击展开

基本信息

Host:https://xrobo.qiniuapi.com

Base Path:/xiaozhi

Method:POST

返回类型:application/json

请求参数

参数名类型必填位置说明

areaCodestring否-区号

captchastring是-图形验证码

captchaIdstring是-验证码ID

mobilestring否-手机号码

passwordstring是-用户密码

usernamestring是-用户名

请求头

Header名类型必填说明

Content-Type是请求内容类型

请求示例

{
  "areaCode": "+86",
  "captcha": "ABCD",
  "captchaId": "d4224c42-a0a2-4e38-87a5-edc3ad03c014",
  "mobile": "13800138000",
  "password": "password123",
  "username": "john_doe"
}

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "token": "4fxxxxxxxxxxxxxxxxxxxxxxx",
    "expire": 43200,
    "clientHash": "xxxxxx"
  }
}

状态码

0登录成功

400请求参数错误

401用户名或密码错误

403验证码错误

500服务器内部错误