compwright/oauth2-servicetitan

ServiceTitan OAuth 2.0 Client Provider for The PHP League OAuth2-Client

Fund package maintenance!
compwright

1.0.1 2022-04-18 20:09 UTC

This package is auto-updated.

Last update: 2024-10-19 01:32:07 UTC


README

Latest Version Build Status Total Downloads

This package provides ServiceTitan OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require compwright/oauth2-servicetitan league/oauth2-client

Usage

Usage is the same as The League's OAuth client, using \Compwright\OAuth2_Servicetitan\Provider as the provider.

Note: for the ServiceTitan integration environment, use \Compwright\OAuth2_Servicetitan\SandboxProvider instead.

Example: Authorization Code Flow

$provider = new Compwright\OAuth2_Servicetitan\Provider([
    'clientId'      => '{servicetitan-client-id}',
    'clientSecret'  => '{servicetitan-client-secret}',
    'redirectUri'   => 'https://example.com/callback-url'
]);

// Get an access token using the authorization code grant
$token = $provider->getAccessToken('client_credentials');

// Use the token to interact with an API on the users behalf
echo $token->getToken();

Testing

$ composer run-script test

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.