socialiteproviders/etsy

Etsy OAuth1 Provider for Laravel Socialite

Etsy

Support for OpenAPI v3 on Etsy., _(*1)

Note: V2 is scheduled to sunset Q4 2022., _(*2)

Installation & Basic Usage

composer require socialiteproviders/etsy

Add configuration to config/services.php

'etsy' => [    
  'client_id' => env('ETSY_CLIENT_ID'),  
  'client_secret' => env('ETSY_CLIENT_SECRET'),  
  'redirect' => env('ETSY_REDIRECT_URI') 
],

Add variables to .env

You can find/update this information from https://www.etsy.com/developers/your-apps, _(*3)

ETSY_CLIENT_ID={YOUR API KEY}
ETSY_CLIENT_SECRET={YOUR SECRET}
ETSY_REDIRECT_URI=https://example.com/callback

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., _(*4)

Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('etsy', \SocialiteProviders\Etsy\Provider::class);
});

Configure the package's listener to listen for SocialiteWasCalled events., _(*6)

Add the event to your listen[] array in app/Providers/EventServiceProvider. See the Base Installation Guide for detailed instructions., _(*7)

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Etsy\EtsyExtendSocialite::class.'@handle',
    ],
];

, _(*8)

Usage web/routes.php

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed)., _(*9)

Note: The email_r is enabled by default so you can access user information in the callback., _(*10)

// the redirect
return Socialite::driver('etsy')
        ->scopes[['include', 'scopes', 'here']]  
        ->redirect();

// the callback
$etsyUser = Socialite::driver('etsy')
        ->user();

Returned User fields

• id
• nickname
• name
• email
• avatar