OAuth::getAccessToken
(PECL OAuth >= 0.99.1)
OAuth::getAccessToken — アクセストークンを取得する
説明
public OAuth::getAccessToken
( string $access_token_url
[, string $verifier_token
[, string $http_method
]] ) : array
アクセストークン、secret そして追加のレスポンスパラメータをサービスプロバイダから取得します。
パラメータ
access_token_url- アクセストークン API の URL。
auth_session_handle- 認証セッションハンドル。このパラメータはコア OAuth 1.0 仕様を引用していませんが、大手プロバイダでは実装されているでしょう。 詳細な情報は » ScalableOAuth を参照ください。
verifier_token- 1.0a をサポートするサービスプロバイダでは、リクエストトークンとアクセストークンを交換する際に
verifier_tokenを渡す必要があります。verifier_tokenが$_GETあるいは$_POSTに存在する場合は自動的にそれが渡され、 呼び出し側がverifier_tokenを指定する必要はありません (通常、アクセストークンを oauth_callback URL で交換する場合はこのようになります)。 詳細な情報は » ScalableOAuth を参照ください。 http_method- 利用する HTTP メソッド。
GETやPOSTなど。
返り値
成功した場合は OAuth レスポンスをパースした配列、失敗した場合は false を返します。
変更履歴
| バージョン | 説明 |
|---|---|
| PECL oauth 1.0.0 | 以前は、失敗したときに false ではなく null を返していました。
|
| PECL oauth 0.99.9 | verifier_token パラメータが追加されました。
|
例
例1 OAuth::getAccessToken() の例
<?phptry { $oauth = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET); $oauth->setToken($request_token,$request_token_secret); $access_token_info = $oauth->getAccessToken("https://example.com/oauth/access_token%22); if(!empty($access_token_info)) { print_r($access_token_info); } else { print "Failed fetching access token, response was: " . $oauth->getLastResponse(); }} catch(OAuthException $E) { echo "Response: ". $E->lastResponse . "\n";}?>
上の例の出力は、 たとえば以下のようになります。
Array
(
[oauth_token] => some_token
[oauth_token_secret] => some_token_secret
)
参考
- OAuth::getLastResponse() - 直近のレスポンスを取得する
- OAuth::getLastResponseInfo() - 直近のレスポンスの HTTP 情報を取得する
- OAuth::setToken() - トークンと secret を設定する
