OAuth::getAccessToken

(PECL OAuth >= 0.99.1)

OAuth::getAccessToken — Fetch an access token

Beschreibung

public OAuth::getAccessToken(
    string $access_token_url,
    string $auth_session_handle = ?,
    string $verifier_token = ?,
    string $http_method = ?
): array

Fetch an access token, secret and any additional response parameters from the service provider.

Parameter-Liste

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 the verifier_token is present in $_GET or $_POST it is passed automatically and the caller does not need to specify a verifier_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.

Rückgabewerte

Returns an array containing the parsed OAuth response on success or false on failure.

Changelog

Version	Beschreibung
PECL oauth 1.0.0	Gab früher bei einem Fehler `null` anstelle von `false` zurück.
PECL oauth 0.99.9	The `verifier_token` parameter was added

Beispiele

Beispiel #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";
}
?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

Array
(
    [oauth_token] => some_token
    [oauth_token_secret] => some_token_secret
)

Siehe auch

OAuth::getLastResponse() - Get the last response
OAuth::getLastResponseInfo() - Get HTTP information about the last response
OAuth::setToken() - Sets the token and secret

add a note

User Contributed Notes 1 note

down

garet dot claborn at gmail dot com ¶

4 years ago


This documentation makes NO ATTEMPT to describe what

The defined constants:
OAUTH_CONSUMER_KEY
OAUTH_CONSUMER_SECRET

Or the defined variable:
$request_token
$request_token_secret

actually should contain or be. are they both the same strings? nobody knows.

add a note