微信登录接口.docx

微信登录接口.docx

《微信登录接口.docx》由会员分享，可在线阅读，更多相关《微信登录接口.docx（17页珍藏版）》请在冰豆网上搜索。

微信登录接口

网站应用微信登录开发指南

准备工作

网站应用微信登录是基于OAuth2.0协议标准构建的微信OAuth2.0授权登录系统。

在进行微信OAuth2.在进行微信OAuth2.0授权登录接入之前，在微信开放平台注册开发者帐号，并拥有一个已审核通过的网站应用，并获得相应的AppID和AppSecret，申请微信登录且通过审核后，可开始接入流程。

授权流程说明

微信OAuth2.0授权登录让微信用户使用微信身份安全登录第三方应用或网站，在微信用户授权登录已接入微信OAuth2.0的第三方应用后，第三方可以获取到用户的接口调用凭证（access_token），通过access_token可以进行微信开放平台授权关系接口调用，从而可实现获取微信用户基本开放信息和帮助用户实现基础开放功能等。

微信OAuth2.0授权登录目前支持authorization_code模式，适用于拥有server端的应用授权。

该模式整体流程为：

1.1.第三方发起微信授权登录请求，微信用户允许授权第三方应用后，微信会拉起应用或重定向到第三方网站，并且带上授权临时票据code参数；

2.2.通过code参数加上AppID和AppSecret等，通过API换取access_token；

3.3.通过access_token进行接口调用，获取用户基本数据资源或帮助用户实现基本操作。

获取access_token时序图：

第一步：

请求CODE

第三方使用网站应用授权登录前请注意已获取相应网页授权作用域（scope=snsapi_login），则可以通过在PC端打开以下链接：

若提示“该链接无法访问”，请检查参数是否填写错误，如redirect_uri的域名与审核时填写的授权域名不一致或scope不为snsapi_login。

参数说明

参数

是否必须

说明

appid

是

应用唯一标识

redirect_uri

是

重定向地址，需要进行UrlEncode

response_type

是

填code

scope

是

应用授权作用域，拥有多个作用域用逗号（,）分隔，网页应用目前仅填写snsapi_login即可

state

否

用于保持请求和回调的状态，授权请求后原样带回给第三方。

该参数可用于防止csrf攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加session进行校验

返回说明

用户允许授权后，将会重定向到redirect_uri的网址上，并且带上code和state参数

redirect_uri?

code=CODE&state=STATE

若用户禁止授权，则重定向后不会带上code参数，仅会带上state参数

redirect_uri?

state=STATE

请求示例

登录一号店网站应用

打开后，一号店会生成state参数，跳转到

微信用户使用微信扫描二维码并且确认登录后，PC端会跳转到

为了满足网站更定制化的需求，我们还提供了第二种获取code的方式，支持网站将微信登录二维码内嵌到自己页面中，用户使用微信扫码授权后通过JS将code返回给网站。

JS微信登录主要用途：

网站希望用户在网站内就能完成登录，无需跳转到微信域下登录后再返回，提升微信登录的流畅性与成功率。

网站内嵌二维码微信登录JS实现办法：

步骤1：

在页面中先引入如下JS文件（支持https）：

步骤2：

在需要使用微信登录的地方实例以下JS对象：

                          varobj=newWxLogin（{

               id:

"login_container", 

               appid:

"", 

               scope:

"", 

               redirect_uri:

"",

               state:

"",

               style:

"",

               href:

""

              }）;

参数说明

参数

是否必须

说明

id

是

第三方页面显示二维码的容器id

appid

是

应用唯一标识，在微信开放平台提交应用审核通过后获得

scope

是

应用授权作用域，拥有多个作用域用逗号（,）分隔，网页应用目前仅填写snsapi_login即可

redirect_uri

是

重定向地址，需要进行UrlEncode

state

否

用于保持请求和回调的状态，授权请求后原样带回给第三方。

该参数可用于防止csrf攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加session进行校验

style

否

提供"black"、"white"可选，默认为黑色文字描述。

详见文档底部FAQ

href

否

自定义样式链接，第三方可根据实际需求覆盖默认样式。

详见文档底部FAQ

第二步：

通过code获取access_token

通过code获取access_token

参数说明

参数

是否必须

说明

appid

是

应用唯一标识，在微信开放平台提交应用审核通过后获得

secret

是

应用密钥AppSecret，在微信开放平台提交应用审核通过后获得

code

是

填写第一步获取的code参数

grant_type

是

填authorization_code

返回说明

正确的返回：

{ 

"access_token":

"ACCESS_TOKEN", 

"expires_in":

7200, 

"refresh_token":

"REFRESH_TOKEN",

"openid":

"OPENID", 

"scope":

"SCOPE","unionid":

"o6_bmasdasdsad6_2sgVt7hMZOPfL"}

参数

说明

access_token

接口调用凭证

expires_in

access_token接口调用凭证超时时间，单位（秒）

refresh_token

用户刷新access_token

openid

授权用户唯一标识

scope

用户授权的作用域，使用逗号（,）分隔

 unionid

当且仅当该网站应用已获得该用户的userinfo授权时，才会出现该字段。

错误返回样例：

{"errcode":

40029,"errmsg":

"invalidcode"}

刷新access_token有效期

access_token是调用授权关系接口的调用凭证，由于access_token有效期（目前为2个小时）较短，当access_token超时后，可以使用refresh_token进行刷新，access_token刷新结果有两种：

1.1.若access_token已超时，那么进行refresh_token会获取一个新的access_token，新的超时时间；

2.2.若access_token未超时，那么进行refresh_token不会改变access_token，但超时时间会刷新，相当于续期access_token。

refresh_token拥有较长的有效期（30天），当refresh_token失效的后，需要用户重新授权。

请求方法

获取第一步的code后，请求以下链接进行refresh_token：

参数说明

参数

是否必须

说明

appid

是

应用唯一标识

grant_type

是

填refresh_token

refresh_token

是

填写通过access_token获取到的refresh_token参数

返回说明

正确的返回：

{ 

"access_token":

"ACCESS_TOKEN", 

"expires_in":

7200, 

"refresh_token":

"REFRESH_TOKEN", 

"openid":

"OPENID", 

"scope":

"SCOPE" 

}

参数

说明

access_token

接口调用凭证

expires_in

access_token接口调用凭证超时时间，单位（秒）

refresh_token

用户刷新access_token

openid

授权用户唯一标识

scope

用户授权的作用域，使用逗号（,）分隔

错误返回样例：

{"errcode":

40030,"errmsg":

"invalidrefresh_token"}

注意：

1、Appsecret是应用接口使用密钥，泄漏后将可能导致应用数据泄漏、应用的用户数据泄漏等高风险后果；存储在客户端，极有可能被恶意窃取（如反编译获取Appsecret）；

2、access_token为用户授权第三方应用发起接口调用的凭证（相当于用户登录态），存储在客户端，可能出现恶意获取access_token后导致的用户数据泄漏、用户微信相关接口功能被恶意发起等行为；

3、refresh_token为用户授权第三方应用的长效凭证，仅用于刷新access_token，但泄漏后相当于access_token泄漏，风险同上。

建议将secret、用户数据（如access_token）放在App云端服务器，由云端中转接口调用请求。

第三步：

通过access_token调用接口

获取access_token后，进行接口调用，有以下前提：

1.1.access_token有效且未超时；

2.2.微信用户已授权给第三方应用帐号相应接口作用域（scope）。

对于接口作用域（scope），能调用的接口有以下：

授权作用域（scope）

接口

接口说明

snsapi_base

/sns/oauth2/access_token

通过code换取access_token、refresh_token和已授权scope

/sns/oauth2/refresh_token

刷新或续期access_token使用

/sns/auth

检查access_token有效性

snsapi_userinfo

/sns/userinfo

获取用户个人信息

其中snsapi_base属于基础接口，若应用已拥有其它scope权限，则默认拥有snsapi_base的权限。

使用snsapi_base可以让移动端网页授权绕过跳转授权登录页请求用户授权的动作，直接跳转第三方网页带上授权临时票据（code），但会使得用户已授权作用域（scope）仅为snsapi_base，从而导致无法获取到需要用户授权才允许获得的数据和基础功能。

接口调用方法可查阅《微信授权关系接口调用指南》

F.A.Q

1.什么是授权临时票据（code）？

答：

第三方通过code进行获取access_token的时候需要用到，code的超时时间为10分钟，一个code只能成功换取一次access_token即失效。

code的临时性和一次保障了微信授权登录的安全性。

第三方可通过使用https和state参数，进一步加强自身授权登录的安全性。

2.什么是授权作用域（scope）？

答：

授权作用域（scope）代表用户授权给第三方的接口权限，第三方应用需要向微信开放平台申请使用相应scope的权限后，使用文档所述方式让用户进行授权，经过用户授权，获取到相应access_token后方可对接口进行调用。

3.网站内嵌二维码微信登录JS代码中style字段作用？

答：

第三方页面颜色风格可能为浅色调或者深色调，若第三方页面为浅色背景，style字段应提供"black"值（或者不提供，black为默认值），则对应的微信登录文字样式为黑色。

相关效果如下：

若提供"white"值，则对应的文字描述将显示为白色，适合深色背景。

相关效果如下：

4.网站内嵌二维码微信登录JS代码中href字段作用？

答：

如果第三方觉得微信团队提供的默认样式与自己的页面样式不匹配，可以自己提供样式文件来覆盖默认样式。

举个例子，如第三方觉得默认二维码过大，可以提供相关css样式文件，并把链接地址填入href字段

.impowerBox.qrcode{width:

200px;}

.impowerBox.title{display:

none;}

.impowerBox.info{width:

200px;}

.status_icon{display：

none}

.impowerBox.status{text-align:

center;} 

相关效果如下：

授权后接口调用（UnionID）

通过code获取access_token

接口说明

通过code获取access_token的接口。

请求说明

http请求方式:

GET

参数说明

参数

是否必须

说明

appid

是

应用唯一标识，在微信开放平台提交应用审核通过后获得

secret

是

应用密钥AppSecret，在微信开放平台提交应用审核通过后获得

code

是

填写第一步获取的code参数

grant_type

是

填authorization_code

返回说明

正确的返回：

{ 

"access_token":

"ACCESS_TOKEN", 

"expires_in":

7200, 

"refresh_token":

"REFRESH_TOKEN",

"openid":

"OPENID", 

"scope":

"SCOPE" 

}

参数

说明

access_token

接口调用凭证

expires_in

access_token接口调用凭证超时时间，单位（秒）

refresh_token

用户刷新access_token

openid

授权用户唯一标识

scope

用户授权的作用域，使用逗号（,）分隔

错误返回样例：

{

"errcode":

40029,"errmsg":

"invalidcode"

}

刷新或续期access_token使用

接口说明

access_token是调用授权关系接口的调用凭证，由于access_token有效期（目前为2个小时）较短，当access_token超时后，可以使用refresh_token进行刷新，access_token刷新结果有两种：

1.1.若access_token已超时，那么进行refresh_token会获取一个新的access_token，新的超时时间；

2.2.若access_token未超时，那么进行refresh_token不会改变access_token，但超时时间会刷新，相当于续期access_token。

refresh_token拥有较长的有效期（30天），当refresh_token失效的后，需要用户重新授权。

请求方法

使用/sns/oauth2/access_token接口获取到的refresh_token进行以下接口调用：

http请求方式:

GET

参数说明

参数

是否必须

说明

appid

是

应用唯一标识

grant_type

是

填refresh_token

refresh_token

是

填写通过access_token获取到的refresh_token参数

返回说明

正确的返回：

{ 

"access_token":

"ACCESS_TOKEN", 

"expires_in":

7200, 

"refresh_token":

"REFRESH_TOKEN", 

"openid":

"OPENID", 

"scope":

"SCOPE" 

}

参数

说明

access_token

接口调用凭证

expires_in

access_token接口调用凭证超时时间，单位（秒）

refresh_token

用户刷新access_token

openid

授权用户唯一标识

scope

用户授权的作用域，使用逗号（,）分隔

错误返回样例：

{

"errcode":

40030,"errmsg":

"invalidrefresh_token"

}

接口说明

检验授权凭证（access_token）是否有效

请求说明

http请求方式:

GET

参数说明

参数

是否必须

说明

access_token

是

调用接口凭证

openid

是

普通用户标识，对该公众帐号唯一

返回说明

正确的Json返回结果：

{ 

"errcode":

0,"errmsg":

"ok"

}

错误的Json返回示例:

{ 

"errcode":

40003,"errmsg":

"invalidopenid"

}

获取用户个人信息（UnionID机制）

接口说明

此接口用于获取用户个人信息。

开发者可通过OpenID来获取用户基本信息。

特别需要注意的是，如果开发者拥有多个移动应用、网站应用和公众帐号，可通过获取用户基本信息中的unionid来区分用户的唯一性，因为只要是同一个微信开放平台帐号下的移动应用、网站应用和公众帐号，用户的unionid是唯一的。

换句话说，同一用户，对同一个微信开放平台下的不同应用，unionid是相同的。

请注意，在用户修改微信头像后，旧的微信头像URL将会失效，因此开发者应该自己在获取用户信息后，将头像图片保存下来，避免微信头像URL失效后的异常情况。

请求说明

http请求方式:

GET

参数说明

参数

是否必须

说明

access_token

是

调用凭证

openid

是

普通用户的标识，对当前开发者帐号唯一

    lang

 否

国家地区语言版本，zh_CN简体，zh_TW繁体，en英语，默认为zh-CN

返回说明

正确的Json返回结果：

{ 

"openid":

"OPENID",

"nickname":

"NICKNAME",

"sex":

1,

"province":

"PROVINCE",

"city":

"CITY",

"country":

"COUNTRY",

"headimgurl":

"

"privilege":

[

"PRIVILEGE1", 

"PRIVILEGE2"

],

"unionid":

"o6_bmasdasdsad6_2sgVt7hMZOPfL"

}

参数

说明

openid

普通用户的标识，对当前开发者帐号唯一

nickname

普通用户昵称

sex

普通用户性别，1为男性，2为女性

province

普通用户个人资料填写的省份

city

普通用户个人资料填写的城市

country

国家，如中国为CN

headimgurl

用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空

privilege

用户特权信息，json数组，如微信沃卡用户为（chinaunicom）

unionid

用户统一标识。

针对一个微信开放平台帐号下的应用，同一用户的unionid是唯一的。

错误的Json返回示例:

{ 

"errcode":

40003,"errmsg":

"invalidopenid"

}

调用频率限制

接口名

频率限制

通过code换取access_token

1万/分钟

刷新access_token

5万/分钟

获取用户基本信息

5万/分钟