upmind/provision-provider-shared-hosting

This provision category contains the common functions used in provisioning flows for accounts/websites on various popular shared hosting platforms.

v6.6.1 2024-04-05 11:38 UTC

README

Latest Version on Packagist

This provision category contains the common functions used in provisioning flows for accounts/websites on various popular shared hosting platforms.

Installation

composer require upmind/provision-provider-shared-hosting

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 AccountInfo Create a web hosting account / website
getInfo() AccountUsername AccountInfo Get information about a hosting account such as the main domain name, whether or not it is suspended, the hostname of it's server, nameservers etc
getUsage() AccountUsername AccountUsage Gets usage information about an account/reseller such as disk space, bandwidth, number of sub-accounts etc
getLoginUrl() GetLoginUrlParams LoginUrl Obtain a signed URL to automatically log into a hosting account
changePassword() ChangePasswordParams EmptyResult Change the password of a hosting account
changePackage() ChangePackageParams AccountInfo Update the product/package a hosting account is set to
suspend() SuspendParams AccountInfo Suspend service for a hosting account
unSuspend() AccountUsername AccountInfo Un-suspend service for a hosting account
terminate() AccountUsername EmptyResult Completely delete a hosting account
grantReseller() GrantResellerParams ResellerPrivileges Grant reseller privileges to a web hosting account, if supported
revokeReseller() AccountUsername ResellerPrivileges Revoke reseller privileges from a web hosting account, if supported

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.