Download the PHP package stitch-digital/laravel-simpro-api without Composer
On this page you can find all versions of the php package stitch-digital/laravel-simpro-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download stitch-digital/laravel-simpro-api
More information about stitch-digital/laravel-simpro-api
Files in stitch-digital/laravel-simpro-api
Package laravel-simpro-api
Short Description Laravel package for working with the Simpro API
License MIT
Homepage https://github.com/stitch-digital/laravel-simpro-api
Informations about the package laravel-simpro-api
Laravel package for working with the Simpro API
Laravel Simpro is a robust package designed to seamlessly integrate your Laravel application with the Simpro API.
The full Simpro API documentation can be found here.
Installation
Laravel Simpro API can be installed using composer:
Then publish the config file:
This will publish the configuration file to config/simpro-api.php
where you can configure your settings:
This package is built using Saloon. Check out their documentation here.
Usage
Using a Single Simpro Connection
If you are using a single Simpro connection, you can add the following environment variables to your .env
file:
To use the package, you can use the Simpro facade to make requests to the API:
Using Multiple Simpro Connections
If you are using multiple Simpro connections, you can pass the base URL and API key to the constructor of the request - although this means you can no longer user the facade:
Available Requests
For a full list of available requests, use the following command:
This package is still in development and not all API endpoints are available yet. We are working on this package regularly as we use it for client projects, with regular releases to add more requests. If you see a missing request, please feel free to create a pull request and contribute!
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Contributions are welcome and will be fully credited! Contributions are accepted via Pull Requests on Github.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- John Trickett
- Anthony Elleray
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-simpro-api with dependencies
illuminate/contracts Version ^10.0||^11.0
saloonphp/cache-plugin Version ^3.0
saloonphp/pagination-plugin Version ^2.0
saloonphp/rate-limit-plugin Version ^2.0
saloonphp/saloon Version ^3.0
spatie/laravel-package-tools Version ^1.16