跳转至

获取一键登录码

1. 接口描述

接口请求路径:POST /prod-api/auth/token/getQuickLoginCode

getQuickLoginCode 用于校验用户账号密码,并返回一键登录所需的 code。code 格式为 console_{毫秒时间戳}_{16位随机},有效期 500 秒,过期后自动失效。

本接口不使用 密钥鉴权 的 Bearer Token,也不校验 agent-api-key。请在请求体携带账号、密码密文和 agentCode

拿到 code 后,请在浏览器打开用户中心过渡页,不要由服务端调用 GET /prod-api/auth/quickLogin

https://{用户中心域名}/cloud/quickLogin?code={code}

可选 Query path:用户中心内部路由,登录成功后跳到该页;不传则进入 /index。取值以 / 开头,不要带 /cloud 前缀。含 ?& 时须对整个 pathencodeURIComponent。示例与说明见 自有平台接入一键登录

注意password 须使用平台 RSA 公钥按 PKCS#1 加密,密文为 URL-Safe Base64。本接口会走正式登录校验,账号停用、未激活或登录错误次数过多时会失败。

平台 RSA 公钥:

-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDC9kMNVuFE+2qnb1vXjlRmjKhd
HR0AEe3i/p0iQNwB082raTulbM2NNdlstG+otWweScbfxwdIj2zylVm31kdEt5yp
wOD4rzDq8MEK51R9wXLzPxPAbJK48occlTdfuh6hX2nK11Toe4D0GaMsE++SanE5
6/d49uXc/ZOrQeAk3QIDAQAB
-----END PUBLIC KEY-----

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。本接口请使用请求体凭证,不要携带 Bearer Token。

参数名称 必选 类型 描述
username String 登录账号,可为用户名、邮箱或手机号。示例值:user@example.com
password String 登录密码密文。解密后明文长度 5~30。采用 RSA PKCS#1 加密,URL-Safe Base64。示例值:{RSA密文}
agentCode String 代理商唯一码,由平台提供。示例值:{agent-code}

3. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:成功
data String 一键登录 code,有效期 500 秒。示例值:console_1715064567089_56gYWsRDP8GEnEJS

4. 示例

示例1 获取一键登录码

输入示例

{
  "username": "user@example.com",
  "password": "{RSA密文}",
  "agentCode": "{agent-code}"
}

代码调用

请将 {登录域名}{agent-code}{RSA密文} 替换为实际值。

curl -X POST 'https://{登录域名}/prod-api/auth/token/getQuickLoginCode' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "user@example.com",
  "password": "{RSA密文}",
  "agentCode": "{agent-code}"
}'
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class GetQuickLoginCodeTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/auth/token/getQuickLoginCode";

        String requestBody = "{"
                + "\"username\":\"user@example.com\","
                + "\"password\":\"{RSA密文}\","
                + "\"agentCode\":\"{agent-code}\""
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}
package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/auth/token/getQuickLoginCode"

    requestBody := []byte(`{
  "username": "user@example.com",
  "password": "{RSA密文}",
  "agentCode": "{agent-code}"
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例

{
  "code": 200,
  "msg": "成功",
  "data": "console_1715064567089_56gYWsRDP8GEnEJS"
}

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
解析失败,请确认RSA公钥是否正确 密码密文无法用平台私钥解密
用户/密码必须填写 username 或解密后的密码为空
用户密码不在指定范围 解密后的明文密码长度不在 5~30
用户名不在指定范围 username 长度不在允许范围
agent_code为空 未传 agentCode
用户名或密码错误 该代理商下找不到对应账号
用户不存在/密码错误。 账号不存在或密码不匹配
登录失败:账户未激活 账号未激活
对不起,您的账号:x 已被删除 账号已删除
对不起,您的账号:x 已停用 账号已停用
您的账号登录错误次数过多已被锁定,请5分钟后再试! 已开启登录锁定且错误次数超限