upmind / provision-provider-office-tools
Provisioning category/provider for professional office tools and services
Requires
- php: >=7.4|>=8.1.0
- firebase/php-jwt: ^v6.9
- upmind/provision-provider-base: ^3.7|^4.0
Requires (Dev)
- phpstan/phpstan: ^1.10
README
This provision category contains functions to facilitate basic online service account creation/management including an automatic login feature.
Installation
composer require upmind/provision-provider-office-tools
Usage
This library makes use of upmind/provision-provider-base primitives which we suggest you familiarize yourself with by reading the usage section in the README.
Quick-start
The easiest way to see this provision category in action and to develop/test changes is to install it in upmind/provision-workbench.
Alternatively you can start using it for your business immediately with Upmind.com - the ultimate web hosting billing and management solution.
If you wish to develop a new Provider, please refer to the WORKFLOW guide.
Supported Providers
The following providers are currently implemented:
Functions
| Function | Parameters | Return Data | Description |
|---|---|---|---|
| create() | CreateParams | InfoResult | Creates a service and returns the username which can be used to identify the service in subsequent requests, plus other service information. |
| getInfo() | ServiceIdentifierParams | InfoResult | Gets info about the service such as plan, status, num_seats etc. |
| login() | LoginParams | LoginResult | Obtain a signed login URL for the service that the system client can redirect to. |
| renew() | RenewParams | InfoResult | Renew the service. |
| changePackage() | ChangePackageParams | InfoResult | Change the package of a service. |
| suspend() | ServiceIdentifierParams | InfoResult | Suspend a service. |
| unsuspend() | ServiceIdentifierParams | InfoResult | Unsuspend a service. |
| terminate() | ServiceIdentifierParams | EmptyResult | Permanently delete a service. |
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
License
GNU General Public License version 3 (GPLv3). Please see License File for more information.
Upmind
Sell, manage and support web hosting, domain names, ssl certificates, website builders and more with Upmind.com - the ultimate web hosting billing and management solution.