puerari/cwp_api

CWP_API is a PHP package that abstracts the interaction with CentOS Web Panel through its API

v1.0 2020-05-24 01:35 UTC

This package is auto-updated.

Last update: 2024-10-29 05:59:35 UTC


README

Maintainer Source Code PHP from Packagist Latest Version Software License Build Quality Score Total Downloads

About CWP API

CWP API is a PHP package that abstracts the interaction with CentOS Web Panel through its API

CWP API é um pacote PHP que abstrai a interação com o Painel de Controle de Hospedagens Web CentOS através de sua API.

About CWP

CentOS Web Panel is a Free Web Hosting control panel designed for quick and easy management of (Dedicated & VPS) servers minus the chore and effort to use ssh console for every time you want to do something, offers a huge number of options and features for server management in its control panel package.

CentOS Web Panel é um Painel de Controle de Hospedagens Web, Gratuito, projetado para gerenciamento rápido e fácil de servidores (dedicados e VPS), que reduz tarefa e o esforço de usar o console ssh sempre que você precisar fazer algo, oferece um grande número de opções e recursos para gerenciamento de servidores em seu pacote do painel de controle.

Highlights

  • Easy to set up (Fácil de configurar)
  • Composer ready (Pronto para o composer)
  • PSR-2 compliant (Compatível com PSR-2)

Installation

CWP_API is available via Composer:

add the following line on your composer.json file

"puerari/cwp_api": "^1.0"

or run

composer require puerari/cwp_api

Usage

Follow the CWP documentation to enable API on your server:

https://docs.control-webpanel.com/docs/developer-tools/api-manager/configuration

Include the Composer autoloader file;

require_once 'vendor/autoload.php';

Instantiate the Cwpapi class

$cwpApi = new Cwpapi('https://yourcwpdomain.com', 'ApiKeyGenetedOnYouCwpAdminPanel');

Call the methods that solve your necessities. Each method is documented in its definition.

See the official documentation on https://docs.control-webpanel.com/docs/developer-tools/api-manager

Example: how to create a new user account and a database associated with the created account.

$status = $cwpApi->createAccount('userdomain.com', 'username', 'userPassword', 'contact@userdomain.com', '123.456.789.0');
if ((json_decode($status))->status != 'OK') {
    exit((json_decode($status))->msj);
}
$status = $cwpApi->createMysqlDatabase('username', 'dbname');
if ((json_decode($status))->status != 'OK') {
    $cwpApi->deleteAccount('username', 'contact@userdomain.com');
    exit((json_decode($status))->msj . ' The account was created, but due to this error we deleted it.');
}
// User account and database successfully created

Support

Security: If you discover any security related issues, please use the issue tracker on GitHub.

Se você descobrir algum problema relacionado à segurança, por favor utilize o rastreador de problemas do GitHub.

Credits

License

The MIT License (MIT). Please see License File for more information.

Contributing

Please see contributing page for details.

Thank You

Let's Code...