socialiteproviders / clover
Clover OAuth2 Provider for Laravel Socialite
Requires
- php: ^8.1
- ext-json: *
- socialiteproviders/manager: ^4.4
This package is auto-updated.
Last update: 2024-11-07 22:01:28 UTC
README
composer require socialiteproviders/clover
Installation & Basic Usage
Please see the Base Installation Guide, then follow the provider specific instructions below.
Ensure the app has permission to read employees.
Add configuration to config/services.php
'clover' => [ 'client_id' => env('CLOVER_CLIENT_ID'), 'client_secret' => env('CLOVER_CLIENT_SECRET'), 'redirect' => env('CLOVER_REDIRECT_URI') 'environment' => env('CLOVER_ENVIRONMENT', 'north_america'), // one of the following: 'sandbox', 'north_america' (for US/Canada), 'europe', or 'latin_america' ],
Add provider event listener
Laravel 11+
In Laravel 11, the default EventServiceProvider
provider was removed. Instead, add the listener using the listen
method on the Event
facade, in your AppServiceProvider
boot
method.
- Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) { $event->extendSocialite('Clover', \SocialiteProviders\Clover\Provider::class); });
Laravel 10 or below
Configure the package's listener to listen for `SocialiteWasCalled` events.Add the event to your listen[]
array in app/Providers/EventServiceProvider
. See the Base Installation Guide for detailed instructions.
protected $listen = [ \SocialiteProviders\Manager\SocialiteWasCalled::class => [ // ... other providers \SocialiteProviders\Clover\CloverExtendSocialite::class.'@handle', ], ];
Usage
You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):
return Socialite::driver('clover')->redirect();
Presumably you are using this OAuth provider in order to retrieve an API token for calling other API endpoints.
The user includes a token
property that you can use to retrieve the API token like this:
Route::get('clover/auth/callback', function () { $user = Socialite::driver('clover')->user(); // Save these tokens somewhere for use with the API. $token = $user->accessTokenResponseBody; // Here’s what it looks like: // [ // 'access_token' => 'JWT', // 'access_token_expiration' => 1709563149, // 'refresh_token' => 'clvroar-6e49ffe9b5122f137aa39d8f7f930558', // 'refresh_token_expiration' => 1741097349, // ] // You may also want to store the merchant ID somewhere. $merchantId = request()->input('merchant_id'); // Here’s what it looks like: // 'ABC123DEF4567' });