Bitrix24 OAuth2 Provider for Laravel Socialite

4.0.0 2021-12-13 00:31 UTC

This package is auto-updated.

Last update: 2024-10-24 02:54:54 UTC


README

composer require socialiteproviders/bitrix24

Installation & Basic Usage

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

Add configuration to config/services.php

'bitrix24' => [
      'endpoint' => env('BITRIX24_ENDPOINT_URI'),
      'client_id' => env('BITRIX24_CLIENT_ID'),
      'client_secret' => env('BITRIX24_CLIENT_SECRET'),
      'redirect' => env('BITRIX24_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('bitrix24', \SocialiteProviders\Bitrix24\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\Bitrix24\Bitrix24ExtendSocialite::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('bitrix24')->redirect();

Returned User fields

  • id
  • name
  • email