跳到主要内容

用户登录接口

POST 
/auth/v1/signin

登录场景说明​

1. 用户名密码登录​

入参要求：​

  • username: 用户名（必填，2-48位，支持英文大小写、数字、特殊字符（仅支持-_.:+ @），且只能以字母或数字开头，不支持中文）
  • password: 密码（必填）

前置条件：​

  • 已注册用户使用用户名密码登录

出参：​

  • 返回标准的token响应（access_token、refresh_token等）

用户名密码登录请求示例​

{
  "username": "zhangsan",
  "password": "DemoPass123!@#"
}

用户名密码登录响应示例​

{
  "token_type": "Bearer",
  "access_token": "your_access_token",
  "refresh_token": "m.aB3cD4eF5gH6iJ7kL8mN9oP0qR1sT2uV3wX4yZ5aB6cD7eF8gH9iJ0kL1mN2oP3qR4sT5uV6wX7yZ8",
  "expires_in": 7200,
  "sub": "9876543210123456789"
}

2. 手机号验证码登录​

入参要求：​

前置条件：​

  • 需要先调用验证码发送接口获取验证码
  • 验证码验证通过后获取verification_token

出参：​

  • 返回标准的token响应（access_token、refresh_token等）

手机号验证码登录请求示例​

{
  "verification_token": "your_access_token"
}

手机号验证码登录响应示例​

{
  "token_type": "Bearer",
  "access_token": "your_access_token",
  "refresh_token": "m.aB3cD4eF5gH6iJ7kL8mN9oP0qR1sT2uV3wX4yZ5aB6cD7eF8gH9iJ0kL1mN2oP3qR4sT5uV6wX7yZ8",
  "expires_in": 7200,
  "sub": "9876543210123456789"
}

3. 邮箱验证码登录​

入参要求：​

前置条件：​

  • 需要先调用邮箱验证码发送接口获取验证码
  • 验证码验证通过后获取verification_token

出参：​

  • 返回标准的token响应（access_token、refresh_token等）

邮箱验证码登录请求示例​

{
  "verification_token": "your_access_token"
}

邮箱验证码登录响应示例​

{
  "token_type": "Bearer",
  "access_token": "your_access_token",
  "refresh_token": "m.aB3cD4eF5gH6iJ7kL8mN9oP0qR1sT2uV3wX4yZ5aB6cD7eF8gH9iJ0kL1mN2oP3qR4sT5uV6wX7yZ8",
  "expires_in": 7200,
  "sub": "9876543210123456789"
}

通用说明：​

  • 三种登录方式互斥，每次请求只能使用一种方式
  • 验证码登录时，需要通过验证短信、邮箱验证码接口获取verification_token
  • 登录成功后返回标准的token响应

Request​

Responses​

Response Headers