mahfuz05/laravel-oauth2

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

, _(*1)

Laravel OAuth2 - Client

This Package can be used to connect to an OAuth2-Service and fetch OAuth2 restricted resources. this is Laravel OAuth rapper for https://github.com/adoy/PHP-OAuth2 , _(*2)

1. Installation

via Composer

Update your composer.json "require"-Section with this line: , _(*3)

    
    "mahfuz05/laravel-oauth2": "dev-master"
    

After adding this line, run the following command: , _(*4)

    
    composer install
    or
    composer update
    

2. Configuration

You need to publish the configuration file of this package with: , _(*5)

    
    php artisan config:publish  mahfuz05/laravel-oauth2
    

The Config-File path is app/config/mahfuz05/laravel-oauth2/config.php

Here you have to add/modify the values for your purpose.
[client.id] - Client-ID of your Application
[client.secret] - Client-Secret of your Application
[scopes] - Scopes for your Application (comma separated) , _(*6)

After modifying the Package-Config, update the app/config/app.php
Modify your providers and aliases section, with your preferred alias:

'providers' => 'Mahfuz05\LaravelOauth2\LaravelOauth2ServiceProvider'
'aliases' => 'LaravelOauth2' => 'Mahfuz05\LaravelOauth2\Facades\LaravelOauth2' , _(*7)

3. Examples

Fetch Access-Token

    
    
    LaravelOauth2::fetchAccessToken('http://3rd.party.com/api/access_token', 'password', array(
        'username'  => $credentials['username'],
        'password'  => $credentials['password'],
        'scope'     => Config::get('oauth2-client::scopes'),
    ));
    
    

Requesting a OAuth2 - Restricted Resource/URL

    
    
    $result = LaravelOauth2::fetch('http://3rd.party.com/api/restriced/resource');
    
    

Or you can use like this

      
      
                if (!isset($_GET['code']))
                {
                    
                    $auth_url = LaravelOauth2::getAuthenticationUrl($this->url, $this->redirectUri);
                    header('Location: ' . $auth_url);
                    die('Redirect');
                }
                else
                {
                    $params = array('code' => $_GET['code'], 'redirect_uri' => $this->redirectUri);
                    
                    $response = LaravelOauth2::getAccessToken($this->token_url, 'authorization_code', $params);
        
                    //get Access Token and store it
                    
                    LaravelOauth2::setAccessToken($response['result']['access_token']);
                    $token = $response['result']['access_token'];
        
                    //get all customers
        
                    $response = LaravelOauth2::fetch('https://api.debitoor.com/api/v1.0/customers');
                }    
       
      
 

4. Constants

Auth methods

• AUTH_TYPE_URI
• AUTH_TYPE_AUTHORIZATION_BASIC
• AUTH_TYPE_FORM

Access token types

• ACCESS_TOKEN_URI
• ACCESS_TOKEN_BEARER
• ACCESS_TOKEN_OAUTH
• ACCESS_TOKEN_MAC

Grant types

• GRANT_TYPE_AUTH_CODE
• GRANT_TYPE_PASSWORD
• GRANT_TYPE_CLIENT_CREDENTIALS
• GRANT_TYPE_REFRESH_TOKEN

HTTP Methods

• HTTP_METHOD_GET
• HTTP_METHOD_POST
• HTTP_METHOD_PUT
• HTTP_METHOD_DELETE
• HTTP_METHOD_HEAD
• HTTP_METHOD_PATCH

HTTP Form content types

• HTTP_FORM_CONTENT_TYPE_APPLICATION
• HTTP_FORM_CONTENT_TYPE_MULTIPART