# auth.code2Session

# 接口说明

通过 tap.login() 接口获取到登录凭证后,开发者可以通过服务端 API 换取用户唯一标识 openid、用户在当前应用下的 unionid 和会话密钥 session_key。

# 接口地址

国内:

GET https://cloud-miniapp.tapapis.cn/auth/v1/jscode2session

国际:

GET https://cloud-miniapp.tapapis.com/auth/v1/jscode2session

# 请求参数

属性 类型 默认值 必填 说明
appid string 小游戏 ID
secret string 小游戏密钥
js_code string 登录时获取的 code
grant_type string authorization_code 授权类型,固定为 authorization_code

# 返回结果

# 正常返回

{
  "openid": "OPENID",
  "session_key": "SESSIONKEY",
  "unionid": "UNIONID"
}
属性 类型 说明
openid string 用户在当前小游戏的唯一标识
session_key string 会话密钥
unionid string 用户在开放平台的唯一标识符,若当前小游戏已绑定到开放平台帐号下会返回,否则不返回

# 错误返回

{
  "errcode": 40029,
  "errmsg": "invalid code"
}
属性 类型 说明
errcode number 错误码
errmsg string 错误信息

# 错误码

错误码 说明
1040029 无效的 code

# 示例代码

# 请求示例

GET https://cloud-miniapp.tapapis.cn/auth/v1/jscode2session?appid=APPID&secret=SECRET&js_code=CODE&grant_type=authorization_code

# 返回示例

{
  "openid": "o6_bmjrPTlm6_2sgVt7hMZOPfL2M",
  "session_key": "tiihtNczf5v6AKRyjwEUhQ==",
  "unionid": "oR5Gjjs56whHYfUzlMYvlSWBhJKA"
}