.NET微信网页开发之网页授权获取用户基本信息

发布于

开发背景

当用户在微信客户端中访问第三方网页，公众号可以通过微信网页授权机制，来获取用户基本信息，进而实现业务逻辑。我们一般通过用户网页授权来无感实现用户登录，并获取用户的微信信息。

注意：用户管理类接口中的“获取用户基本信息接口”，是在用户和公众号产生消息交互或关注后事件推送后，才能根据用户OpenID来获取用户基本信息。这个接口，包括其他微信接口，都是需要该用户（即openid）关注了公众号后，才能调用成功的。

开发前配置

需要先到公众平台官网中的「设置与开发」-「功能设置」-「网页授权域名」的配置选项中，修改授权回调域名。请注意，这里填写的是域名（是一个字符串），而不是URL，因此请勿加 http:// 等协议头；

网页授权的两种scope的区别说明

  1. 以snsapi_base为scope发起的网页授权，是用来获取进入页面的用户的openid的，并且是静默授权并自动跳转到回调页的。用户感知的就是直接进入了回调页（往往是业务页面）
  2. 以snsapi_userinfo为scope发起的网页授权，是用来获取用户的基本信息的。但这种授权需要用户手动同意，并且由于用户同意过，所以无须关注，就可在授权后获取该用户的基本信息。

第一步、用户同意授权获取code

在确保微信公众账号拥有授权作用域（scope参数）的权限的前提下（已认证服务号，默认拥有scope参数中的snsapi_base和snsapi_userinfo 权限），引导关注者打开如下页面：

若提示“该链接无法访问”，请检查参数是否填写错误，是否拥有scope参数对应的授权作用域权限。跳转回调redirect_uri，应当使用https链接来确保授权code的安全性，并且是在微信公众号后台配置的网页授权域名的访问地址。

  • https://open.weixin.qq.com/connect/oauth2/authorize?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect

请求参数：

参数

是否必须

说明

appid

是

公众号的唯一标识

redirect_uri

是

授权后重定向的回调链接地址， 请使用 urlEncode 对链接进行处理

response_type

是

返回类型，请填写code

scope

是

应用授权作用域，snsapi_base （不弹出授权页面，直接跳转，只能获取用户openid），snsapi_userinfo （弹出授权页面，可通过openid拿到昵称、性别、所在地。并且， 即使在未关注的情况下，只要用户授权，也能获取其信息 ）

state

否

重定向后会带上state参数，开发者可以填写a-zA-Z0-9的参数值，最多128字节

#wechat_redirect

是

无论直接打开还是做页面302重定向时候，必须带此参数

forcePopup

否

强制此次授权需要用户弹窗确认；默认为false；需要注意的是，若用户命中了特殊场景下的静默授权逻辑，则此参数不生效

  • 获取code后，请求以下链接获取access_token：https://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code

请求参数：

参数

是否必须

说明

appid

是

公众号的唯一标识

secret

是

公众号的appsecret

code

是

填写第一步获取的code参数

grant_type

是

填写为authorization_code

返回参数：

参数

描述

access_token

网页授权接口调用凭证,注意：此access_token与基础支持的access_token不同

expires_in

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

refresh_token

用户刷新access_token

openid

用户唯一标识，请注意，在未关注公众号时，用户访问公众号的网页，也会产生一个用户和公众号唯一的OpenID

scope

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

is_snapshotuser

是否为快照页模式虚拟账号，只有当用户是快照页模式虚拟账号时返回，值为1

unionid

用户统一标识（针对一个微信开放平台账号下的应用，同一用户的 unionid 是唯一的），只有当scope为"snsapi_userinfo"时返回

正确时返回的JSON数据包如下：

代码语言：javascript
复制
{
  "access_token":"ACCESS_TOKEN",
  "expires_in":7200,
  "refresh_token":"REFRESH_TOKEN",
  "openid":"OPENID",
  "scope":"SCOPE",
  "is_snapshotuser": 1,
  "unionid": "UNIONID"
}

错误时微信会返回JSON数据包如下（示例为Code无效错误）:

代码语言：javascript
复制
{"errcode":40029,"errmsg":"invalid code"}

请求示例代码：

代码语言：javascript
复制
    public class WeChatLogin : Controller
    {

    /// <summary>
    /// 获取微信网页授权access_token
    /// </summary>
    /// <param name="state">自定义参数</param>
    /// <param name="code">通过用户授权后得到的code</param>
    /// <returns></returns>
    public async Task<Response> GetWeChatAccessToken(string state, string code)
    {
        string appId = "YourAppId";
        string appSecret = "YourAppSecret";
        string requestUrl = $"https://api.weixin.qq.com/sns/oauth2/access_token?appid={appId}&secret={appSecret}&code={code}&grant_type=authorization_code";

        using (var httpClient = new HttpClient())
        {
            var httpRequest = new HttpRequestMessage(HttpMethod.Get, requestUrl);
            using (var response = await httpClient.SendAsync(httpRequest))
            {
                if (response.IsSuccessStatusCode)
                {
                    var responseString = await response.Content.ReadAsStringAsync();
                    var responseData = JsonConvert.DeserializeObject<WeChatTokenResponse>(responseString);

                    return new Response
                    {
                        Code = 1,
                        Message = responseData.AccessToken
                    };
                }
                else
                {
                    var errorResponseString = await response.Content.ReadAsStringAsync();
                    var errorData = JsonConvert.DeserializeObject<ErrorResponse>(errorResponseString);

                    return new Response
                    {
                        Code = 0,
                        Message = $"Failed to get access token: {errorData.ErrMsg}"
                    };
                }
            }
        }
    }
}

public class WeChatTokenResponse
{
    [JsonProperty("access_token")]
    public string AccessToken { get; set; }

    [JsonProperty("expires_in")]
    public int ExpiresIn { get; set; }

    [JsonProperty("refresh_token")]
    public string RefreshToken { get; set; }

    [JsonProperty("openid")]
    public string OpenId { get; set; }

    [JsonProperty("scope")]
    public string Scope { get; set; }

    [JsonProperty("is_snapshotuser")]
    public int IsSnapshotUser { get; set; }

    [JsonProperty("unionid")]
    public string UnionId { get; set; }
}

public class ErrorResponse
{
    [JsonProperty("errcode")]
    public int ErrCode { get; set; }

    [JsonProperty("errmsg")]
    public string ErrMsg { get; set; }
}</code></pre></div></div><h3 id="1nsqu" name="%E7%AC%AC%E4%B8%89%E6%AD%A5%E3%80%81%E8%8E%B7%E5%8F%96%E7%94%A8%E6%88%B7%E4%BF%A1%E6%81%AF(%E9%9C%80scope%E4%B8%BA-snsapi_userinfo)">第三步、获取用户信息(需scope为 snsapi_userinfo)</h3><p>如果网页授权作用域为snsapi_userinfo，则此时开发者可以通过access_token和openid拉取用户信息了。</p><ul class="ul-level-0"><li>请求方法：https://api.weixin.qq.com/sns/userinfo?access_token=ACCESS_TOKEN&amp;openid=OPENID&amp;lang=zh_CN</li></ul><h4 id="2hhvo" name="%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0%EF%BC%9A">请求参数：</h4><div class="table-wrapper"><table><thead><tr><th style="text-align:left"><div><div class="table-header"><p>参数</p></div></div></th><th style="text-align:left"><div><div class="table-header"><p>描述</p></div></div></th></tr></thead><tbody><tr><td style="text-align:left"><div><div class="table-cell"><p>access_token</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>网页授权接口调用凭证,注意：此access_token与基础支持的access_token不同</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>openid</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>用户的唯一标识</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>lang</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>返回国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语</p></div></div></td></tr></tbody></table></div><h4 id="ahtdf" name="%E8%BF%94%E5%9B%9E%E5%8F%82%E6%95%B0%EF%BC%9A">返回参数：</h4><div class="table-wrapper"><table><thead><tr><th style="text-align:left"><div><div class="table-header"><p>参数</p></div></div></th><th style="text-align:left"><div><div class="table-header"><p>描述</p></div></div></th></tr></thead><tbody><tr><td style="text-align:left"><div><div class="table-cell"><p>openid</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>用户的唯一标识</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>nickname</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>用户昵称</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>sex</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>用户的性别，值为1时是男性，值为2时是女性，值为0时是未知</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>province</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>用户个人资料填写的省份</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>city</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>普通用户个人资料填写的城市</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>country</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>国家，如中国为CN</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>headimgurl</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空。若用户更换头像，原有头像URL将失效。</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>privilege</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>用户特权信息，json 数组，如微信沃卡用户为（chinaunicom）</p></div></div></td></tr><tr><td style="text-align:left"><div><div class="table-cell"><p>unionid</p></div></div></td><td style="text-align:left"><div><div class="table-cell"><p>只有在用户将公众号绑定到微信开放平台账号后，才会出现该字段。</p></div></div></td></tr></tbody></table></div><p><strong>正确时返回的JSON数据包如下：</strong></p><div class="rno-markdown-code"><div class="rno-markdown-code-toolbar"><div class="rno-markdown-code-toolbar-info"><div class="rno-markdown-code-toolbar-item is-type"><span class="is-m-hidden">代码语言：</span>javascript</div></div><div class="rno-markdown-code-toolbar-opt"><div class="rno-markdown-code-toolbar-copy"><i class="icon-copy"></i><span class="is-m-hidden">复制</span></div></div></div><div class="developer-code-block"><pre class="prism-token token line-numbers language-javascript"><code class="language-javascript" style="margin-left:0">{   



"openid": "OPENID",

"nickname": NICKNAME,

"sex": 1,

"province":"PROVINCE",

"city":"CITY",

"country":"COUNTRY",

"headimgurl":"https://thirdwx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ4eMsv84eavHiaiceqxibJxCfHe/46",

"privilege":[ "PRIVILEGE1" "PRIVILEGE2"     ],

"unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"

}

错误时微信会返回JSON数据包如下（示例为openid无效）:

代码语言：javascript
复制
{"errcode":40003,"errmsg":" invalid openid "}

请求示例代码：

代码语言：javascript
复制
    public class WeChatLogin : Controller

{

/// <summary>

/// 用户信息获取

/// </summary>

/// <param name="accessToken"> 网页授权接口调用凭证,注意：此access_token与基础支持的access_token不同</param>

/// <param name="openId">用户的唯一标识</param>

/// <returns></returns>

public async Task<Response> GetWeChatUserInfo(string accessToken, string openId)

{

string requestUrl = $"https://api.weixin.qq.com/sns/userinfo?access_token={accessToken}&openid={openId}&lang=zh_CN";


        using (var httpClient = new HttpClient())
        {
            var request = new HttpRequestMessage(HttpMethod.Get, requestUrl);
            var response = await httpClient.SendAsync(request);

            if (response.IsSuccessStatusCode)
            {
                var responseString = await response.Content.ReadAsStringAsync();
                var responseData = JsonConvert.DeserializeObject&lt;WeChatUserInfoResponse&gt;(responseString);

                return new Response
                {
                    Code = 1,
                    Message = $&#34;Nickname: {responseData.Nickname}, Province: {responseData.Province}, City: {responseData.City}&#34;
                };
            }
            else
            {
                var errorResponseString = await response.Content.ReadAsStringAsync();
                var errorData = JsonConvert.DeserializeObject&lt;ErrorResponse&gt;(errorResponseString);

                return new Response
                {
                    Code = 0,
                    Message = $&#34;Failed to get user info: {errorData.ErrMsg}&#34;
                };
            }
        }
    }

    public class WeChatUserInfoResponse
    {
        [JsonProperty(&#34;openid&#34;)]
        public string OpenId { get; set; }

        [JsonProperty(&#34;nickname&#34;)]
        public string Nickname { get; set; }

        [JsonProperty(&#34;sex&#34;)]
        public int Sex { get; set; }

        [JsonProperty(&#34;province&#34;)]
        public string Province { get; set; }

        [JsonProperty(&#34;city&#34;)]
        public string City { get; set; }

        [JsonProperty(&#34;country&#34;)]
        public string Country { get; set; }

        [JsonProperty(&#34;headimgurl&#34;)]
        public string HeadImgUrl { get; set; }

        [JsonProperty(&#34;privilege&#34;)]
        public List&lt;string&gt; Privilege { get; set; }

        [JsonProperty(&#34;unionid&#34;)]
        public string UnionId { get; set; }
    }

    public class ErrorResponse
    {
        [JsonProperty(&#34;errcode&#34;)]
        public int ErrCode { get; set; }

        [JsonProperty(&#34;errmsg&#34;)]
        public string ErrMsg { get; set; }
    }
}</code></pre></div></div><h3 id="fomt2" name="%E5%8F%82%E8%80%83%E6%96%87%E7%AB%A0">参考文章</h3><p>https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html</p>
#微信#公众号#接口#开发#作用域