Upmind Provision Providers - Generic API
This provision category contains common functions which should cover the lifecycle of the majority of provisionable online services. Ships with a custom function definition which can be used for additional flexibility.
composer require upmind/provision-provider-generic-apiThis library makes use of upmind/provision-provider-base primitives which we suggest you familiarize yourself with by reading the usage section in the README.
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.
See DEVELOPMENT.md for full setup and usage instructions.
The following providers are currently implemented:
| Function | Parameters | Return Data | Description |
|---|---|---|---|
| create() | CreateParams | ServiceInfo | Creates a new service and returns service information |
| getInfo() | ServiceIdentifierParams | ServiceInfo | Retrieves information about a service |
| suspend() | ServiceIdentifierParams | ServiceInfo | Suspends an active service |
| unsuspend() | ServiceIdentifierParams | ServiceInfo | Unsuspends a suspended service |
| terminate() | ServiceIdentifierParams | Empty Result | Terminates a service |
| changePackage() | ChangePackageParams | ServiceInfo | Changes the package of a service |
| customFunction() | CustomFunctionParams | ServiceInfo | Executes a custom function with custom parameters and returns a mixed result |
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
GNU General Public License version 3 (GPLv3). Please see License File for more information.
Sell, manage and support web hosting, domain names, ssl certificates, website builders and more with Upmind.com.