henter/wechat-oauth

WeChat OAuth SDK

微信登录SDK

, _(*1)

Overview

微信OAuth登录SDK, _(*2)

Installation

Composer (推荐)

把下面的配置加入你的composer.json文件, _(*3)

"henter/wechat-oauth": "dev-master"

然后使用Composer来安装SDK, _(*4)

composer install

如果Packagist故障或者不可用导致无法安装SDK的，可以使用Satis或者Artifact来进行本地安装，详见Composer文档中的Repositories, _(*5)

Manually

复制lib/Henter/WeChat到项目目录，然后require "/path/to/sdk/OAuth.php", _(*6)

Usage

Autoload

如果你用Composer来安装，可以用以下代码自动加载, _(*7)

require 'vendor/autoload.php';

SDK位于全局命名空间下。, _(*8)

use Henter\WeChat\OAuth

Initialization

实例化OAuth即可完成初始化, _(*9)

$oauth = new \Henter\WeChat\OAuth($appid, $secret);

$appid和$secret是微信开放平台的应用的唯一标识和秘钥AppSecret, _(*10)

Code samples

登录

$oauth = new \Henter\WeChat\OAuth($appid, $secret);
$callback_url = 'http://your_site.com/your_callback_url';
$url = $oauth->getAuthorizeURL($callback_url);

重定向到$url，待用户允许授权后，将会重定向到$callback_url上，并且带上code和state参数（示例代码未传入state参数）, _(*11)

默认授权地址是跳转到微信扫描二维码页面（适用于PC端），如果用户在微信内访问网页点微信登陆，这种方式不太适合。 需要用下面的方法获取用于微信内的授权地址：, _(*12)

$url = $oauth->getWeChatAuthorizeURL($callback_url);

注：这个在微信开放平台文档上没有（只在公众号平台文档有提到），不过测试发现同样适用于开放平台应用。, _(*13)

通过code参数获取access_token

//获取code参数
$code = $_GET['code'];

$oauth = new \Henter\WeChat\OAuth($appid, $secret);
if($access_token = $oauth->getAccessToken('code', $code)){
    $refresh_token = $oauth->getRefreshToken();
    $expires_in = $oauth->getExpiresIn();
    $openid = $oauth->getOpenid();
}else{
    echo $oauth->error();
}

如果获取成功，需保存这4个值用于后续接口调用，否则通过$oauth->error()获取错误信息, _(*14)

通过access_token调用API

$oauth = new \Henter\WeChat\OAuth($appid, $secret, $access_token);

或, _(*15)

$oauth = new \Henter\WeChat\OAuth($appid, $secret);
$oauth->setAccessToken($access_token);

调用用户信息，需传入openid, _(*16)

$userinfo = $oauth->api('sns/userinfo', array('openid'=>$openid));

其中sns/userinfo为api类型，具体请参考微信API文档, _(*17)

通过refresh_token刷新或续期access_token

$oauth = new \Henter\WeChat\OAuth($appid, $secret);

//以下两种方式一样
$access_token = $oauth->getAccessToken('token', $refresh_token);
或
$access_token = $oauth->refreshAccessToken($refresh_token);

此时可以通过$oauth->getRefreshToken()获取新的refresh_token, _(*18)

其它

本SDK无任何抛异常部分，调用$oauth->getAccessToken()或$oauth->api()等方法时如果返回false则表示未成功，错误信息均通过$oauth->error()获取，所以无需使用try {} catch {}方式处理错误, _(*19)

License

The MIT License (MIT) Copyright (c) 2014 Henter <henter@henter.me>, _(*20)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:, _(*21)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., _(*22)

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE., _(*23)