compwright/oauth2-servicetitan

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

1.0.2 2024-12-03 18:52 UTC

Requires

• php: ^7.3 || ^8.0
• league/oauth2-client: ^2.5
• psr/http-message: ^1.0 || ^2.0

Requires (Dev)

• mockery/mockery: ^1.4
• phpunit/phpunit: ^9.5
• psr/http-message: ^1.1
• squizlabs/php_codesniffer: ^3.6

MIT

• Jonathon Hill

• authorization
• client
• oauth
• oauth2
• provider
• authorisation
• servicetitan

README

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

• Jonathon Hill, CompWright Enterprises, LLC

License

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