avito / oauth2-avito
Avito OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Requires
- php: >=7.1 || >=8.0
- ext-json: *
- league/oauth2-client: ^2.6
Requires (Dev)
- phpunit/phpunit: ~4.5
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-04-13 07:52:49 UTC
README
В данном пакете представлена поддержка протокола OAuth 2.0 в Avito для библитеки PHP League OAuth 2.0 Client.
Установка
Установить можно с помощью composer:
composer require avito/oauth2-avito
Использование
Использование идентично использованию The League's OAuth client, используя Avito\OAuth2\Client\Provider\Avito
в качестве провайдера.
Обработка кода авторизации (Authorization Code)
$provider = new Avito([ 'clientId' => 'YOUR_CLIENT_ID', 'clientSecret' => 'YOUR_CLIENT_SECRET', 'redirectUri' => 'http://your-redirect-uri', ]); if (isset($_GET['code']) && $_GET['code']) { //Вызов функции setBaseDomain требуется для установки контектс аккаунта. if (isset($_GET['referer'])) { $provider->setBaseDomain($_GET['referer']); } $token = $provider->getAccessToken('authorization_code', [ 'code' => $_GET['code'] ]); //todo сохраняем access, refresh токены и привязку к аккаунту и возможно пользователю /** @var \Avito\OAuth2\Client\Provider\AvitoResourceOwner $ownerDetails */ $ownerDetails = $provider->getResourceOwner($token); printf('Hello, %s!', $ownerDetails->getName()); }
Обновление access токена
$provider = new Avito([ 'clientId' => 'YOUR_CLIENT_ID', 'clientSecret' => 'YOUR_CLIENT_SECRET', 'redirectUri' => 'http://your-redirect-uri', ]); //todo получение токена из хранилища $provider->setBaseDomain($token['baseDomain']); /** * Проверяем активен ли токен и делаем запрос или обновляем токен */ if (time() >= $token['expires']) { /** * Получаем токен по рефрешу */ try { $accessToken = $provider->getAccessToken(new League\OAuth2\Client\Grant\RefreshToken(), [ 'refresh_token' => $token['refreshToken'], ]); //todo сохраняем новые access, refresh токены и привязку к аккаунту и возможно пользователю } catch (Exception $e) { die((string)$e); } } //todo повторяем исходный запрос
Кнопка на сайт
Для удобства можно разместить кнопку на сайт для простой установки созданной интеграции.
<div class="button"></div>
<script
class="Avito_oauth"
charset="utf-8"
data-client-id="xxxxxx-client-id-xxxxxx"
data-title="Добавить в Avito"
data-compact="false"
data-class-name="className"
data-color="red"
data-state="random string"
src="https://www.Avito.ru/auth/button.js"
></script>
Пример
В рамках данного репозитория имеется файл example.php, который реализует простейшую логику авторизации, сохранения токена, а также совершения запросов. Для использования нужно указать корректные значения при создании провайдера в файле, а также Redirect URI в интеграции ведущий на вызов этого файла на вашем сервере. Дальше для теста можно перейти на страницу example.php, после чего будет отображена кнопка для открытия модального окна автооризации приложения в Avito. После получения доступов вы увидете имя пользователя на экране. Если добавить GET параметр - request=1, то будет совершен запрос за информацией об аккаунте с сохраненным ранее токеном.