league/oauth2-instagram

The PHP League OAuth2-Client 的 Instagram OAuth 2.0 客户端提供者

3.1.0 2022-02-09 20:30 UTC

This package is auto-updated.

Last update: 2024-08-23 18:15:22 UTC


README

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

本软件包为 PHP League 的 OAuth 2.0 客户端提供 Instagram OAuth 2.0 支持。OAuth 2.0 客户端

安装

要安装,请使用 composer

composer require league/oauth2-instagram

使用方法

使用方法与 The League 的 OAuth 客户端相同,使用 \League\OAuth2\Client\Provider\Instagram 作为提供者。

授权码流

$provider = new League\OAuth2\Client\Provider\Instagram([
    'clientId'          => '{instagram-client-id}',
    'clientSecret'      => '{instagram-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'host'              => 'https://api.instagram.com',  // Optional, defaults to https://api.instagram.com
    'graphHost'         => 'https://graph.instagram.com' // Optional, defaults to https://graph.instagram.com
]);

if (!isset($_GET['code'])) {

    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {

    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);

    // Optional: Now you have a token you can look up a users profile data
    try {

        // We got an access token, let's now get the user's details
        $user = $provider->getResourceOwner($token);

        // Use these details to create a new profile
        printf('Hello %s!', $user->getNickname());

    } catch (Exception $e) {

        // Failed to get user details
        exit('Oh dear...');
    }

    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

请求长期访问令牌

$token = $provider->getAccessToken('authorization_code', [
    'code' => $_GET['code']
]);
    
$longLivedToken = $provider->getLongLivedAccessToken($token);

刷新长期访问令牌

$token = $provider->getAccessToken('authorization_code', [
    'code' => $_GET['code']
]);

// you need to fetch a long-lived token first!    
$longLivedToken = $provider->getLongLivedAccessToken($token);

$refreshedToken = $provider->getRefreshedAccessToken($longLivedToken);

管理作用域

在创建 Instagram 授权 URL 时,您可以指定应用程序可以授权的状态和作用域。

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['user_profile', 'user_media'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

如果两者都没有定义,提供者将使用内部默认值。

在编写此文档时,以下作用域可用:以下作用域可用

  • user_profile
  • user_media

测试

$ ./vendor/bin/phpunit

贡献

请参阅CONTRIBUTING以获取详细信息。

致谢

许可证

MIT 许可证(MIT)。请参阅许可证文件获取更多信息。