/workos-php-laravel

Official PHP Laravel SDK for interacting with the WorkOS API

Primary LanguagePHPMIT LicenseMIT

workos-php-laravel

Laravel SDK to conveniently access the WorkOS API.

For more information on our API and WorkOS, check out our docs here.

Installation

To install via composer, run the following:

composer require workos/workos-php-laravel

For Laravel 5.0-5.4, add the WorkOS ServiceProvider in your config/app.php:

"providers" => array(
    // ...
    WorkOS\Laravel\WorkOSServiceProvider::class
)

For Laravel 5.5 and up, 6.x and 7.x... you're all set!

Getting Started

Create a WorkOS configuration file by running the following:

php artisan vendor:publish --provider="WorkOS\Laravel\WorkOSServiceProvider"

The package will need to be configured with your api key and project id. By default, the package will look for a WORKOS_API_KEY and WORKOS_PROJECT_ID environment variable.

Usage

Underneath it all, the Laravel SDK utilizes the WorkOS PHP SDK. For more information on usage, check out the docs here and the PHP SDK here.