|
| 1 | +wechat-oauth |
| 2 | +=============== |
| 3 | + |
| 4 | +微信公共平台OAuth接口消息接口服务中间件与API SDK |
| 5 | + |
| 6 | +## 模块状态 |
| 7 | + |
| 8 | +- [](http://badge.fury.io/js/wechat-oauth) |
| 9 | +- [](https://travis-ci.org/node-webot/wechat-oauth) |
| 10 | +- [](https://david-dm.org/node-webot/wechat-oauth) |
| 11 | +- [](https://coveralls.io/r/node-webot/wechat-oauth) |
| 12 | + |
| 13 | +## 功能列表 |
| 14 | +- OAuth授权 |
| 15 | +- 获取基本信息 |
| 16 | + |
| 17 | +OAuth2.0网页授权，使用此接口须通过微信认证，如果用户在微信中（Web微信除外）访问公众号的第三方网页，公众号开发者可以通过此接口获取当前用户基本信息（包括昵称、性别、城市、国家）。详见：[官方文档](http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息) |
| 18 | + |
| 19 | +详细参见[API文档](http://node-webot.github.io/wechat-oauth/api.html) |
| 20 | + |
| 21 | +## Installation |
| 22 | + |
| 23 | +```sh |
| 24 | +$ npm install wechat-oauth |
| 25 | +``` |
| 26 | + |
| 27 | +## Usage |
| 28 | + |
| 29 | +### 初始化 |
| 30 | +引入OAuth并实例化 |
| 31 | + |
| 32 | +```js |
| 33 | +var OAuth = require('wechat-oauth'); |
| 34 | +var client = new OAuth('your appid', 'your secret'); |
| 35 | +``` |
| 36 | + |
| 37 | +以上即可满足单进程使用。 |
| 38 | +当多进程时，token需要全局维护，以下为保存token的接口。 |
| 39 | + |
| 40 | +```js |
| 41 | +var oauthApi = new OAuth('appid', 'secret', function (openid, callback) { |
| 42 | + // 传入一个根据openid获取对应的全局token的方法 |
| 43 | + fs.readFile(openid +':access_token.txt', 'utf8', function (err, txt) { |
| 44 | + if (err) {return callback(err);} |
| 45 | + callback(null, JSON.parse(txt)); |
| 46 | + }); |
| 47 | +}, function (openid, token, callback) { |
| 48 | + // 请将token存储到全局，跨进程、跨机器级别的全局，比如写到数据库、redis等 |
| 49 | + // 这样才能在cluster模式及多机情况下使用，以下为写入到文件的示例 |
| 50 | + // 持久化时请注意，每个openid都对应一个唯一的token! |
| 51 | + fs.writeFile(openid + ':access_token.txt', JSON.stringify(token), callback); |
| 52 | +}); |
| 53 | +``` |
| 54 | + |
| 55 | +## 引导用户 |
| 56 | +生成引导用户点击的URL |
| 57 | + |
| 58 | +```js |
| 59 | +var url = client.getAuthorizeURL('redirectUrl', 'state', 'scope'); |
| 60 | +``` |
| 61 | + |
| 62 | +用户点击上步生成的URL后会被重定向到上步设置的 `redirectUrl`，并且会带有`code`参数，我们可以使用这个`code`换取`access_token`和用户的`openid` |
| 63 | + |
| 64 | +```js |
| 65 | +client.getAccessToken('code', function (err, result) { |
| 66 | + var accessToken = result.data.access_token; |
| 67 | + var openid = result.data.openid; |
| 68 | +}); |
| 69 | +``` |
| 70 | + |
| 71 | +如果我们生成引导用户点击的URL中`scope`参数值为`snsapi_userinfo`，接下来我们就可以使用`openid`换取用户详细信息（必须在getAccessToken方法执行完成之后） |
| 72 | + |
| 73 | +```js |
| 74 | +client.getUser('openid', function (err, result) { |
| 75 | + var userInfo = result; |
| 76 | +}); |
| 77 | +``` |
| 78 | + |
| 79 | +## 捐赠 |
| 80 | +如果您觉得Wechat OAuth对您有帮助，欢迎请作者一杯咖啡 |
| 81 | + |
| 82 | + |
| 83 | + |
| 84 | +或者[](https://www.gittip.com/JacksonTian/) |
| 85 | + |
| 86 | +## 交流群 |
| 87 | +QQ群：157964097，使用疑问，开发，贡献代码请加群。 |
| 88 | + |
| 89 | +## Contributors |
| 90 | +感谢以下贡献者： |
| 91 | + |
| 92 | +``` |
| 93 | +$ git summary |
| 94 | +
|
| 95 | + project : wechat |
| 96 | + repo age : 1 year, 10 months |
| 97 | + active : 122 days |
| 98 | + commits : 287 |
| 99 | + files : 33 |
| 100 | + authors : |
| 101 | + 239 Jackson Tian 83.3% |
| 102 | + 10 yelo 3.5% |
| 103 | + 9 ifeiteng 3.1% |
| 104 | + 4 realdog 1.4% |
| 105 | + 4 Bruce Lee 1.4% |
| 106 | + 3 Guo Yu 1.0% |
| 107 | + 2 zhongao 0.7% |
| 108 | + 2 Jesse Yang 0.7% |
| 109 | + 2 Lu Jun 0.7% |
| 110 | + 2 dan 0.7% |
| 111 | + 1 Rogerz Zhang 0.3% |
| 112 | + 1 Chen Wei 0.3% |
| 113 | + 1 feichang.wyl 0.3% |
| 114 | + 1 feit 0.3% |
| 115 | + 1 Qun Lin 0.3% |
| 116 | + 1 p13766 0.3% |
| 117 | + 1 LiSheep 0.3% |
| 118 | + 1 xianda 0.3% |
| 119 | + 1 Lance Li 0.3% |
| 120 | + 1 TooBug 0.3% |
| 121 | +
|
| 122 | +``` |
| 123 | + |
| 124 | +## License |
| 125 | +The MIT license. |
0 commit comments