chrisjohnleah / bigchange-api-laravel
Laravel bridge for the BigChange REST and optional JobWatch SDK.
Package info
github.com/chrisjohnleah/bigchange-api-laravel
pkg:composer/chrisjohnleah/bigchange-api-laravel
Requires
- php: ^8.3
- chrisjohnleah/bigchange-api: ^1.0
- illuminate/cache: ^11.0|^12.0|^13.0
- illuminate/support: ^11.0|^12.0|^13.0
Requires (Dev)
- pestphp/pest: ^5.0
README
Laravel bridge for chrisjohnleah/bigchange-api, the
framework-agnostic Saloon SDK for the BigChange REST API and optional JobWatch
attachment service.
composer require chrisjohnleah/bigchange-api-laravel
The bridge provides the BigChange facade, automatic service-provider
discovery, a cache-backed token store, and a manager that builds a
customer-scoped SDK client. OAuth transport, pagination, response types, and
provider limits remain in the core package; migration and plan policy belong
in the consuming application.
use ChrisJohnLeah\BigChangeLaravel\Facades\BigChange; $client = BigChange::client([ 'client_id' => $clientId, 'client_secret' => $clientSecret, 'customer_id' => $customerId, ]); $jobs = $client->jobs(pageSize: 1000); $assets = $client->assetManagementClient()->assets(pageSize: 2000); $jobWatch = BigChange::jobWatchClient([ 'jobwatch_username' => $username, 'jobwatch_password' => $password, 'jobwatch_company_key' => $companyKey, ]);
JobWatch uses separate Basic Auth credentials and a company-key header. Only use it when the customer's BigChange account has the JobWatch service enabled.
Publish the optional cache configuration with:
php artisan vendor:publish --tag=bigchange-config
The cache store only holds short-lived access tokens. Credentials should be provided by the consuming application’s secret manager or environment.