wechat-oauth

OAuth接口[wechat-oauth]

微信公共平台OAuth接口消息接口服务中间件与API SDK

模块状态

  • NPM version
  • Build Status
  • Dependencies Status
  • Coverage Status

功能列表

  • OAuth授权
  • 获取基本信息

OAuth2.0网页授权，使用此接口须通过微信认证，如果用户在微信中（Web微信除外）访问公众号的第三方网页，公众号开发者可以通过此接口获取当前用户基本信息（包括昵称、性别、城市、国家）。详见：官方文档

详细参见API文档

Installation

$ npm install wechat-oauth

Usage

初始化

引入OAuth并实例化

var OAuth = require('wechat-oauth');
var client = new OAuth('your appid', 'your secret');

以上即可满足单进程使用。 当多进程时，token需要全局维护，以下为保存token的接口。

var oauthApi = new OAuth('appid', 'secret', function (openid, callback) {
  // 传入一个根据openid获取对应的全局token的方法
  fs.readFile(openid +':access_token.txt', 'utf8', function (err, txt) {
    if (err) {return callback(err);}
    callback(null, JSON.parse(txt));
  });
}, function (openid, token, callback) {
  // 请将token存储到全局，跨进程、跨机器级别的全局，比如写到数据库、redis等
  // 这样才能在cluster模式及多机情况下使用，以下为写入到文件的示例
  // 持久化时请注意，每个openid都对应一个唯一的token!
  fs.writeFile(openid + ':access_token.txt', JSON.stringify(token), callback);
});

引导用户

生成引导用户点击的URL

var url = client.getAuthorizeURL('redirectUrl', 'state', 'scope');

用户点击上步生成的URL后会被重定向到上步设置的 redirectUrl，并且会带有code参数，我们可以使用这个code换取access_token和用户的openid

client.getAccessToken('code', function (err, result) {
  var accessToken = result.data.access_token;
  var openid = result.data.openid;
});

如果我们生成引导用户点击的URL中scope参数值为snsapi_userinfo，接下来我们就可以使用openid换取用户详细信息（必须在getAccessToken方法执行完成之后）

client.getUser('openid', function (err, result) {
  var userInfo = result;
});

捐赠

如果您觉得Wechat OAuth对您有帮助，欢迎请作者一杯咖啡

捐赠wechat

或者

交流群

QQ群：157964097，使用疑问，开发，贡献代码请加群。

Contributors

感谢以下贡献者：

$ git summary

 project  : wechat-oauth
 repo age : 31 minutes
 active   : 1 days
 commits  : 2
 files    : 10
 authors  :
     2  Jackson Tian  100.0%

License

The MIT license.