hansadema/mofh-client

This package is abandoned and no longer maintained. The author suggests using the infinityfree/mofh-client package instead.

A WHM API client for MyOwnFreeHost in PHP

0.4.0 2019-11-07 19:47 UTC

Requires

• guzzlehttp/guzzle: ~6.0

Requires (Dev)

• fzaninotto/faker: 1.7
• mockery/mockery: ^0.9
• phpunit/phpunit: ^5.7

Apache-2.0

• Hans Adema

README

An API client to use the free hosting system from MyOwnFreeHost.

IMPORTANT: THIS LIBRARY IS AIMED AT EXPERIENCED PHP DEVELOPERS. Experience with object-oriented PHP and Composer is required. If you can't use oo-PHP and Composer, don't bother with this library.

Installation

This package is best installed through Composer:

composer require hansadema/mofh-client

Usage

Before you can get started, you need to get the API credentials from MyOwnFreeHost. Login to the reseller panel, go to API -> Setup WHM API -> select the domain you want to configure. Copy the API Username and API password and set your own IP address as the Allowed IP Address (the IP address of your computer, server, or wherever you want to use this API client).

The MyOwnFreeHost API exposes the following methods. The available parameters are listed below.

• createAccount
  • username: A unique, 8 character identifier of the account.
  • password: A password to login to the control panel, FTP and databases.
  • domain: A domain name to create the account. Can be a subdomain or a custom domain.
  • email: The email address of the user.
  • plan: The name of the hosting plan to create the account on. Requires a hosting package to be configured through MyOwnFreeHost.
• suspend
  • username: The unique, 8 character identifier of the account.
  • reason: A string with information about why you are suspending the account.
  • linked: If true, related accounts will be suspended as well.
• unsuspend
  • username: The unique, 8 character identifier of the account.
• password
  • username: The unique, 8 character identifier of the account.
  • password: The new password to set for the account.
• availability
  • domain: The domain name or subdomain to check.
• getUserDomains
  • username: The vistaPanel login username (e.g. abcd_12345678).

Example

use \HansAdema\MofhClient\Client;

// Create a new API client with your API credentials.
$client = Client::create([
    'apiUsername' => 'your_api_username',
    'apiPassword' => 'your_api_password',
    'plan' => 'my_plan', // Optional, you can define it here or define it with the createAccount call.
]);

// Create a request object to create the request.
$request = $client->createAccount([
    'username' => 'abcdefgh', // A unique, 8 character identifier of the account.
    'password' => 'password123', // A password to login to the control panel, FTP and databases.
    'domain' => 'userdomain.example.com', // Can be a subdomain or a custom domain.
    'email' => '[e-mail]', // The email address of the user.
    'plan' => 'my_plan', // Optional, you can submit a hosting plan here or with the Client instantiation.
]);

// Send the API request and keep the response.
$response = $request->send();

// Check whether the request was successful.
if ($response->isSuccessful()) {
   echo 'You can login as: ' . $response->getVpUsername();
} else {
   echo 'Failed to create account: ' . $response->getMessage();
}

License

Copyright 2019 Hans Adema

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.