# 小程序登录凭证校验

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:code2Session

登录凭证校验。通过 wx.login 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程。更多使用方法详见小程序登录。

# 1. 调用方式

# HTTPS 调用

GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JS_CODE&grant_type=GRANT_TYPE

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
appidstring小程序 appId
secretstring小程序 appSecret
js_codestring登录时获取的 code,可通过wx.login获取
grant_typestring授权类型,此处只需填写 authorization_code

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
session_keystring会话密钥
unionidstring用户在开放平台的唯一标识符,若当前小程序已绑定到微信开放平台帐号下会返回,详见 UnionID 机制说明
openidstring用户唯一标识
errcodenumber错误码,请求失败时返回
errmsgstring错误信息,请求失败时返回

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code

返回示例

{
  "openid": "xxxxxx",
  "session_key": "xxxxx",
  "unionid": "xxxxx",
  "errcode": 0,
  "errmsg": "xxxxx"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
40029code 无效js_code无效
40226code blocked高风险等级用户,小程序登录拦截 。风险等级详见用户安全解方案
45011api minute-quota reach limit  mustslower  retry next minuteAPI 调用太频繁,请稍候再试

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
小程序小游戏
  • ✔:该账号可调用此接口
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;