OAuth::getAccessToken
(PECL OAuth >= 0.99.1)
OAuth::getAccessToken — Fetch an access token
Description
$access_token_url
[, string $auth_session_handle
[, string $verifier_token
[, string $http_method
]]] ) : arrayFetch an access token, secret and any additional response parameters from the service provider.
Parameters
-
access_token_url
-
URL to the access token API.
-
auth_session_handle
-
Authorization session handle, this parameter does not have any citation in the core OAuth 1.0 specification but may be implemented by large providers. » See ScalableOAuth for more information.
-
verifier_token
-
For service providers which support 1.0a, a
verifier_token
must be passed while exchanging the request token for the access token. If theverifier_token
is present in$_GET
or$_POST
it is passed automatically and the caller does not need to specify averifier_token
(usually if the access token is exchanged at the oauth_callback URL). » See ScalableOAuth for more information. -
http_method
-
HTTP method to use, e.g. GET or POST.
Changelog
Version | Description |
---|---|
1.0.0 |
Previously returned NULL on failure, instead of FALSE .
|
0.99.9 |
The verifier_token parameter was added
|
Examples
Example #1 OAuth::getAccessToken() example
<?php
try {
$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");
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";
}
?>
The above example will output something similar to:
Array ( [oauth_token] => some_token [oauth_token_secret] => some_token_secret )
See Also
- OAuth::getLastResponse() - Get the last response
- OAuth::getLastResponseInfo() - Get HTTP information about the last response
- OAuth::setToken() - Sets the token and secret
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-oauth.getaccesstoken.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.