Salla Ecommerce OAuth2 Provider for Laravel Socialite

dev-master 2024-09-11 23:32 UTC

This package is auto-updated.

Last update: 2024-09-12 08:20:49 UTC


README

composer require socialiteproviders/salla

Create Account & App on Salla Partner

First you need to register account on Salla Partners Portal and create your app to get credentials client_id & client_secret. See the docs for more info Salla API Docs

Installation & Basic Usage

Please see the Base Installation Guide, then follow the provider specific instructions below.

Add configuration to config/services.php

'salla' => [    
    'client_id' => env('SALLA_CLIENT_ID'),
    'client_secret' => env('SALLA_CLIENT_SECRET'),
    'redirect' => env('SALLA_REDIRECT_URI'),
],

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('salla', \SocialiteProviders\Salla\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\Salla\SallaExtendSocialite::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('salla')->redirect();

After redirect, You may return User instance:

return Socialite::driver('salla')->user();

Returned User fields

  • id
  • name
  • email
  • mobile
  • role
  • merchant
    • id
    • username
    • name
    • avatar
    • plan
    • status
    • domain
    • tax_number
    • commercial_number