qg.login

基础信息说明

功能概述：调用平台的登录能力，完成用户登录操作。

项目	说明
版本要求	无
前提条件	做好sdk接入前准备，详见下方相关教程
使用限制	无
相关教程	重要：详情使用见小游戏联运SDK接入文档

参数说明

qg.login(option)

属性名	类型	默认值（如有）	必填	说明
success	Function	-	否	登录成功的回调函数；入参 res
fail	Function	-	否	登录失败的回调函数；入参 err
complete	Function	-	否	登录完成的回调函数；入参与成功/失败一致

返回值说明

这是一个同步方法，无同步返回；通过回调异步返回。

回调结果说明

回调成功

判定条件：当 res.data.session 与 res.data.appAccountId 同时存在时视为成功

参数名	类型	描述
appAccountId	Int	游戏服务计费系统用户 ID，作为用户的唯一标识
session	String	本次登录游戏的会话 ID（当前登录有效，会过期）

回调失败

参数名	类型	说明
errMsg	String	错误信息
errCode	Number	错误码

触发与阶段说明

阶段	触发时机	说明
发起登录	调用 qg.login(option)	透传到平台代理执行登录
成功判定	收到响应后	同时存在 res.data.session 与 res.data.appAccountId 为成功
成功回调	判定成功	调用 option.success(res)，随后调用 option.complete(res)
失败回调	判定失败或异常	调用 option.fail(err)（含 errMsg/errCode），随后 complete(err)
完成回调	成功或失败后	始终调用 option.complete(...)

示例代码

// 登录
qg.login({
  success: res => {
    // 仅当 res.data.session 与 res.data.appAccountId 同时存在时视为成功
    console.log('qg.login():success res.data.session:: ', res.data.session)
    console.log('qg.login():success res.data.appAccountId:: ', res.data.appAccountId)
  },
  fail: err => {
    // 失败对象包含 errMsg、errCode
    console.error('登录失败', err)
  },
  complete: out => {
    console.log('登录完成', out)
  }
})

服务端对接说明

Session 验证（必接）

说明：CP游戏客户端调用qg.login获取小游戏客户端返回的登录信息后，需要将登录信息返回给游戏服务器验证登录结果，校验过程需要服务端配合完成，详情使用见：https://dev.mi.com/xiaomihyperos/documentation/detail?pId=1109#_2

接口地址:https://mis.migc.xiaomi.com/api/biz/service/loginvalidate
请求方式:GET/POST
Headers:Content-Type: application/x-www-form-urlencoded

请求参数说明

参数名	必填	说明
appId	是	游戏 ID
session	是	用户 session ID（来自 qg.login 成功返回）
uid	是	用户 ID，须与登录返回的 appAccountId 一致
signature	是	使用 appSecret 生成的签名，签名方法以平台说明为准

示例代码

POST https://mis.migc.xiaomi.com/api/biz/service/loginvalidate

appId=2882303761517239138&session=1nlfxuAGmZk9IR2L&uid=100010&signature=b560b14efb18ee2eb8f85e51c5f7c11f697abcfc

返回参数说明

参数名	必有	说明
errcode	是	状态码: 200 验证正确 1515 appId 错误 1516 uid 错误 1520 session 错误 1525 signature 错误 4002 appid, uid, session 不匹配(常见为session过期)
errMsg	否	错误信息
adult	否	用户实名标识： 407 实名认证通过，年龄大于18岁 408 实名认证通过，年龄小于18岁 409 未进行实名认证

注意事项

服务端验证为必接，请在登录成功后立即进行校验并处理过期等场景

上一篇:用户信息

下一篇:支付

文档内容是否有帮助？

有帮助

无帮助