接口概述

  • 接口地址http[s]://ip:port/api/v1/third_api/login
  • 请求方法POST
  • 接口状态码200

接口描述

这是一个第三方登录的 API,用于通过第三方平台进行用户登录操作,获取访问令牌。

请求参数

  • 数据结构
    • key:用于校验的密钥,不能为空,与服务器端设置的密钥进行匹配,若不匹配则返回密钥错误的提示。
    • user_name:用户的账号,不能为空,登录时用于查找用户信息。
    • phone_number:(可选)用户的手机号码,用于注册新用户时的信息记录。
    • email:(可选)用户的电子邮箱,用于注册新用户时的信息记录。
    • dept_code(可选):用户的部门编码,用户注册时用于设置部门信息。
    • dept_name(可选):用户的部门名称,默认值为 “暂无部门”,用户注册时用于设置部门信息。
    • nickname(可选):用户的昵称,不传该参数默认值为 用户账号,用户注册时用于设置昵称信息。

返回数据

  • 数据结构

    • access_token:访问令牌,用于用户在应用中的身份验证,以 JSON 字符串形式作为访问令牌的主体。
  • 数据格式resp_200(data=access_token),表示返回的数据为一个包含 access_token 的对象,且状态码为 200 表示请求成功。

请求示例

  • 请求 URLhttp[s]://ip:port/api/v1/third_api/login
  • 请求头 :Content-Type: application/json
  • 请求体
{
  "key": "your_api_key",
  "user_name": "your_username",
  "phone_number": "your_phone_number",
  "email": "your_email"
}

响应示例

  • 成功响应
{
  "code": 200,
  "data": "your_access_token"
}
  • 失败响应

密钥错误

{
  "code": 500,
  "detail": "密钥错误"
}

账号不能为空

{
  "code": 500,
  "detail": "账号不能为空"
}

备注

  • 该接口会验证用户提交的密钥是否与服务器端设置的密钥匹配,若不匹配则返回密钥错误的提示。
  • 若用户已存在,则会根据用户的角色信息生成访问令牌并返回;若用户不存在,则会创建新用户并为其分配默认角色,然后生成访问令牌返回。
  • 获取token之后需重定向到http://ip:port/authRedirect?from=xxx&token=xxx&redirect=xxx from填充任意值即可 redirect的值为去除域名后扳手平台页面相对路径,代表跳转到哪个页面