README

此包为 PHP League 的 OAuth 2.0 客户端 提供Slack OAuth 2.0 支持。

安装

要安装，请使用 composer

$ composer require adam-paterson/oauth2-slack

使用

用法与 League 的 OAuth 客户端相同，使用 \AdamPaterson\OAuth2\Client\Provider\Slack 作为提供者。

授权码流

<?php

session_start();
 
$provider = new \AdamPaterson\OAuth2\Client\Provider\Slack([
    'clientId'          => '{slack-client-id}',
    'clientSecret'      => '{slack-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
]);
 
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
        $team = $provider->getResourceOwner($token);
 
        // Use these details to create a new profile
        printf('Hello %s!', $team->getName());
 
    } 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();
}

作用域

OAuth 作用域，表示您希望您的应用能够访问 Slack 用户账户的哪些部分。完整的作用域列表可以在 此处 找到。

$provider = new \AdamPaterson\OAuth2\Client\Provider\Slack([
   'clientId'          => '{slack-client-id}',
   'clientSecret'      => '{slack-client-secret}',
   'redirectUri'       => 'https://example.com/callback-url',
]);
   
$authUrl = $provider->$provider->getAuthorizationUrl([
   'scope' => 'user:read user:write file:write'
]);

机器人访问令牌

如果您的 Slack 应用包括一个机器人用户，在批准后，JSON 响应将包含一个额外的节点，包含一个特定于您的机器人用户的访问令牌，在批准的工作空间上下文中使用。

注意：您必须传递 bot 作用域，此额外节点才存在

$authUrl = $provider->$provider->getAuthorizationUrl([
    'scope' => 'bot'
]);  
 
$token = $provider->getAccessToken('authorization_code', [
    'code' => $_GET['code']
]);
 
$values = $token->getValues();
 
// bot user id
$botUserId = $values['bot']['bot_user_id'];
$botAccessToken = $values['bot']['bot_access_token'];

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息，请参阅 CONTRIBUTING。

鸣谢

• Adam Paterson
• 所有贡献者

许可

MIT 许可证（MIT）。有关更多信息，请参阅 许可文件。