cpanelinc / publicapi-php Goto Github PK

View Code? Open in Web Editor NEW

109.0 18.0 53.0 319 KB

cPanel PublicAPI PHP client and cPanel PHP library

PHP 100.00%

publicapi-php's Introduction

cPanel PublicAPI PHP Repository

This is the repository for the cPanel PublicAPI client written in PHP.

What's Included

The repository contains the following items. Each of which is explained in further detail below:

The cPanel PHP library
The PublicAPI client class
An examples directory
The PHPUnit tests for the cPanel PHP library and PublicAPI client class

QuickStart Example of the PublicAPI Client

This quick start example illustrates:

Instantiating the PublicAPI client object with a configuration array.
Invoking the whm_api() method for querying the XML-API::version function
Getting the version string from the response object

Code: <?php

    // Include the autoloader
    require_once realpath( dirname(__FILE__) . '/Util/Autoload.php');
    
    // Make a configuration data array
    $config = array(
        'service' => array(
            'whm' => array(
                'config'    => array(
                    'host' => '10.1.4.191',
                    'user' => 'root',
                    'password' => 'rootsecret'
                ),
            ),
        ),
    );
    
    // Instantiate the PublicAPI client
    $cp = Cpanel_PublicAPI::getInstance($config);
    
    // Make a Whostmgr query
    $response = $cp->whm_api('version');
    
    // Print result string
    echo "WHM Version: {$response->version}\n";
    
?>

The cPanel PHP Library

The cPanel PHP library is a foundation for developers to build applications and scripts that interact with cPanel systems.

Version 0.1.0 is compatible with PHP >= 5.2

The library is divided into components. The follow list itemizes a few of the components, and their description, that are in the library:

Cpanel_Query

Abstract classes for creating objects that can query a cPanel system
Cpanel_Service

Concrete and abstract classes that represent cPanel Services like Whostmgr and cPanel
Cpanel_Parser

Classes that allow for encoding and decoding common string and data structures
Cpanel_Util

Utility files and scripts for developing with the cPanel library
... and others

The PublicAPI Client Class

PublicAPI is the moniker for cPanel's defined, client interface: A contract if you will, that presents a language agnostic set of methods for interacting with cPanel systems.

The PublicAPI PHP client class in this repository is a PHP implementation of that interface. The client supports all methods of the PublicAPI interface as well as most of the methods available in previous PHP client classes, such as the XML-API client class.

Examples of how to code with the PublicAPI client class can be found:

In brief: The QuickStart Example of the PublicAPI Client section of this document
In detail: The examples directory, Cpanel/Examples/ within the repository

Version 0.1.0 is compatible with PHP >= 5.2

Examples Directory

There are several example files located in Cpanel/Examples/. Reading Introduction_to_PublicAPI.php is a good place to start. All other examples assume that you have read it.

Each example file is a working example if you substitute your own credentials and host information.

In fact, you can even run the LivePHP example, Using_the_LivePHP_Service.php, locally without having to download and install it respective of the LivePHP environment. This is possible due to a mock server that is part of the testing apparatus. Note: this is a very, very simple mock server and is not intended for anything other than example usage. So please, do not implement or rely on it.

Unit Tests

Unit tests for the cPanel PHP library and the PublicAPI client class are included in the Cpanel/Tests/ directory. They are written for use with PHPUnit >= 3.5 These test will require PHP 5.3 or greater, as they use specific Reflection functions that allow for assertions to be made on properties and methods whose visibility is private or protected.

publicapi-php's People

Stargazers

Watchers

Forkers

learan85 davidneimeyer dineshkummarc anton-nesterenko surajt griv juji dmitry-lomakin nocriz eflage tvaughan73 go-nut eresults rayhanlucky frantzcy ajdove pagmovel muyaedward elliotmoso shirone spamexperts surjit alexr1712 max13 t-moor adyygupta mircobabini boxygen debjit joejordanbrown ahmadrais stefb965 mkubenka thiagoaf1406 aaronwest22 thiagobueno denazebiz dustin-s ismail774403783 13garth fishawack tareq0065 brilliant88work erikthiart doctormap1 conceptdelapaix isaacdaramola phoenixwade l3aalteshuva cassimahmedattia eco5sdefi

publicapi-php's Issues

Gres

https://github.com/sc-forks/buidler-e2e/blob/02be82d7c799918f9200da912f5a883bce10c9f5/package-lock.json

Learn Bitcoin, Earn Bitcoin

https://www.earncarrot.com/[]()

Upload files using the Api

Hi,
I've been trying this for the last 2 days put can not figure it out.
As a reseller I want to create new cpanel account and upload my app in it.
I create the account, create database in it, create dbuser etc.

But how can I use the api to upload the files of the app?

Full path of image

The api

http://docs.cpanel.net/twiki/bin/view/ApiDocs/Api1/ApiBandwidth#Bandwidth::displaymainbwheader

returns tmp image . The return path should be full path instead of /tmp/instantm/bw-somethign-today.png

WHM create account

Hi,
Is there any way to create a new account with the api?

count(): Parameter must be an array or an object that implements Countable

I'm getting this error
Warning: count(): Parameter must be an array or an object that implements Countable in /home/servername/publicapi-php-master/Cpanel/PublicAPI.php on line 343
Using php 7.1 on Hawk Host shared server Aug 31 2019

Suggestion about __call method

On line 55 you could change
from:
return json_decode($this->APIcall($name, $arguments[0]));
to:
return json_decode($this->APIcall($name, $arguments[0]), true);
That will return a full array of arrays instead of a object of arrays and objects.

I changed on my local file.

Uncaught TypeError: array_key_exists(): Argument #2

I'm getting this error.

Fatal error:  Uncaught TypeError: array_key_exists(): Argument #2 ($array) must be of type array, ArrayObject given in C:\xampp\htdocs\tests\cpanel\Cpanel\Core\Object.php:111
Stack trace:
#0 C:\xampp\htdocs\tests\cpanel\Cpanel\Core\Object.php(74): Cpanel_Core_Object->setOptions(Array)
#1 C:\xampp\htdocs\tests\cpanel\Cpanel\PublicAPI.php(102): Cpanel_Core_Object->__construct(Array)
#2 C:\xampp\htdocs\tests\cpanel\Cpanel\PublicAPI.php(140): Cpanel_PublicAPI->__construct(Array)
#3 C:\xampp\htdocs\tests\cpanel\index.php(11): Cpanel_PublicAPI::getInstance()
#4 {main}
  thrown in C:\xampp\htdocs\tests\cpanel\Cpanel\Core\Object.php on line 111

The code is:

 // Include the autoloader
 require_once realpath( dirname(__FILE__) . '/Cpanel/Util/Autoload.php');
    
 // Make a configuration data array
 $config=array(
    'service'=> array(
        'whm'=> array(
            'config'   => array(
                'host'=> '95.217.75.9',
                'user'=> 'transpas',
                'password'=> 'K05c?@eMpW8]'
            ),
        ),
    ),
);
$cp=Cpanel_PublicAPI::getInstance($config);
$accounts=$cp->whm_api('listaccts');
print_R($accounts);

PHP Strict standards: Only variables should be passed by reference in D:\tmp\publicapi-php-master\publicapi-php-master\Cpanel\Ser
vice\Abstract.php on line 518