OAuth::getAccessToken

(PECL OAuth >= 0.99.1)

OAuth::getAccessToken — Получить токен доступа

Описание

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

Получает токен доступа, его пароль и все дополнительные параметры ответа от провайдера сервиса.

Список параметров

access_token_url: URL до API выдачи токена доступа.
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	Раньше в случае возникновения ошибки возвращался `null` вместо `false`.
PECL oauth 0.99.9	Добавлен параметр `verifier_token`

Примеры

Пример #1 Пример использования OAuth::getAccessToken()

<?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 "Не удалось получить токен доступа, ответ был: " . $oauth->getLastResponse();
    }
} catch(OAuthException $E) {
    echo "Ответ: ". $E->lastResponse . "\n";
}
?>

Вывод приведённого примера будет похож на:

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

Смотрите также

OAuth::getLastResponse() - Получить последний ответ
OAuth::getLastResponseInfo() - Получить HTTP-информацию о последнем ответе
OAuth::setToken() - Задать токен и его пароль

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