league / oauth1-trello
Trello OAuth 1.0 Client Provider for The PHP League OAuth1-Client
Requires
- php: >=5.5.0
- league/oauth1-client: dev-develop
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is auto-updated.
Last update: 2025-03-14 11:40:12 UTC
README
This package provides Trello OAuth 1.0 support for the PHP League's OAuth 1.0 Client.
Installation
To install, use composer:
composer require league/oauth1-trello
Usage
Usage is the same as The League's OAuth client, using \League\OAuth1\Client\Server\Trello
as the server.
Authenticating with OAuth 1.0
// Create a server instance. $server = new \League\OAuth1\Client\Server\Trello([ 'identifier' => 'your-identifier', 'secret' => 'your-secret', 'callbackUri' => 'http://your-callback-uri/', // The following can be used to set defaults for the server 'scope' => 'read', 'expiration' => '1day', 'name' => 'Trello App' ]); // Obtain Temporary Credentials and User Authorization if (!isset($_GET['oauth_token'], $_GET['oauth_verifier'])) { // First part of OAuth 1.0 authentication is to // obtain Temporary Credentials. $temporaryCredentials = $server->getTemporaryCredentials(); // Store credentials in the session, we'll need them later $_SESSION['temporary_credentials'] = serialize($temporaryCredentials); session_write_close(); // Second part of OAuth 1.0 authentication is to obtain User Authorization // by redirecting the resource owner to the login screen on the server. // Create an authorization url. $authorizationUrl = $server->getAuthorizationUrl($temporaryCredentials); // Redirect the user to the authorization URL. The user will be redirected // to the familiar login screen on the server, where they will login to // their account and authorize your app to access their data. header('Location: ' . $authorizationUrl); exit; // Obtain Token Credentials } else { try { // Retrieve the temporary credentials we saved before. $temporaryCredentials = unserialize($_SESSION['temporary_credentials']); // We will now obtain Token Credentials from the server. $tokenCredentials = $server->getTokenCredentials( $temporaryCredentials, $_GET['oauth_token'], $_GET['oauth_verifier'] ); // We have token credentials, which we may use in authenticated // requests against the service provider's API. echo $tokenCredentials->getIdentifier() . "\n"; echo $tokenCredentials->getSecret() . "\n"; // Using the access token, we may look up details about the // resource owner. $resourceOwner = $server->getResourceOwner($tokenCredentials); var_export($resourceOwner->toArray()); // The server provides a way to get an authenticated API request for // the service, using the access token; it returns an object conforming // to Psr\Http\Message\RequestInterface. $request = $server->getAuthenticatedRequest( 'GET', 'http://your.service/endpoint', $tokenCredentials ); } catch (\League\OAuth1\Client\Exceptions\Exception $e) { // Failed to get the token credentials or user details. exit($e->getMessage()); } }
Configuring your server
In order to complete the authorization flow with your user, you will need to provide three additional pieces of information.
name | description |
---|---|
scope |
Scope informs the Trello service about which permissions you are requesting on behalf of your user. read or read,write |
expiration |
Expiration informs the Trello service about how long you are requesting this permissions. 1day , 3days , never |
name |
Name informs the Trello service about the name of your application. This will be displayed to your users during authorization. |
You may configure your server to include this information when creating the server.
// Create a server instance. $server = new \League\OAuth1\Client\Server\Trello([ 'identifier' => 'your-identifier', 'secret' => 'your-secret', 'callbackUri' => 'http://your-callback-uri/', 'scope' => 'read', 'expiration' => '1day', 'name' => 'Trello App' ]);
You may also provide this information when creating your authorization url.
// Create a server instance. $server = new \League\OAuth1\Client\Server\Trello([ 'identifier' => 'your-identifier', 'secret' => 'your-secret', 'callbackUri' => 'http://your-callback-uri/', ]); $temporaryCredentials = $server->getTemporaryCredentials(); $options = [ 'scope' => 'read', 'expiration' => '1day', 'name' => 'Trello App' ]; $authorizationUrl = $server->getAuthorizationUrl($temporaryCredentials, $options);
Configuration provided when creating your authorization url with take precedence over default configuration.
Sending one-off requests
You may use the server to create authenticated requests for one-off or trivial needs. If your needs are more robust, trello-php is recommended.
$server = new \League\OAuth1\Client\Server\Trello([ 'identifier' => 'your-identifier', 'secret' => 'your-secret', 'callbackUri' => 'http://your-callback-uri/', ]); $token = 'your-resource-owner-token'; $secret = 'your-resource-owner-secret'; $tokenCredentials = new \League\OAuth1\Client\Credentials\TokenCredentials($token, $secret); $request = $server->getAuthenticatedRequest( 'get', 'https://api.trello.com/1/members/me/boards', $tokenCredentials ); $client = new \GuzzleHttp\Client(); $response = $client->send($request);
Running the included example
This project contains some example code within the example
directory at the root of this project.
First, open the example/index.php
file and update the server configuration with your Trello App Identifier and Secret.
Then run the code in your browser. Using the built-in server provided by PHP may be the fastest options. From the command line, and at the root of the project running the following command.
php -S localhost:9000 -t example
The built-in web server should begin running and when you browse to http://localhost:9000
in your favorite browser, you can begin testing your configuration.
Testing
$ ./vendor/bin/phpunit
$ ./vendor/bin/phpcs src --standard=psr2 -sp
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.