https://github.com/proficlos/vestacp-api

https://github.com/proficlos/vestacp-api

api api-client php php-library php7 vesta vestacp

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/proficlos/vestacp-api
• Owner: ProfiCloS
• License: mit
• Created: 2019-02-04T21:55:58.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-07T22:46:00.000Z (about 5 years ago)
• Last Synced: 2024-04-18T04:22:44.203Z (9 months ago)
• Topics: api, api-client, php, php-library, php7, vesta, vestacp
• Language: PHP
• Size: 52.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub version](https://badge.fury.io/gh/ProfiCloS%2Fvestacp-api.svg)](https://badge.fury.io/gh/ProfiCloS%2Fvestacp-api)

[![Build Status](https://travis-ci.com/ProfiCloS/vestacp-api.svg?branch=master)](https://travis-ci.com/ProfiCloS/vestacp-api)

[![codecov](https://codecov.io/gh/ProfiCloS/vestacp-api/branch/master/graph/badge.svg)](https://codecov.io/gh/ProfiCloS/vestacp-api)

# VestaCP PHP API

## How to use

1) Installation

	```sh

	$ composer require proficlos/vestacp-api

	```

2) Create Client

	a) Easy way

	```php

	use ProfiCloS\VestaCP\Client;

	

	// easy way to create Client

	$client = Client::simpleFactory('https://someHost', 'someUser', 'somePass');

	```

	

	b) For some reasons (more hosts, etc) you may need create objects alone

	```php

	use ProfiCloS\VestaCP\Client;

	use ProfiCloS\VestaCP\Authorization\Credentials;

	use ProfiCloS\VestaCP\Authorization\Host;

	

	$credentials = new Credentials('someUser', 'somePassword');

	$host = new Host('https://someHost', $credentials);

	$client = new Client($host);

	```

3) Usage

	```php

	// verify login

	$client->testAuthorization(); // bool

	```

	You can simply send one of prepared commands (or you can write own command - must implements `\ProfiCloS\VestaCP\Command\ICommand` )

	```php

	$command = new SomeCommand(); 

	$response = $client->send( $command );

	echo $response->getResponseText();

	```

	Or you can use prepared modules

	

	a) user module

	

	```php

	$userModule = $client->getModuleUser();

	$userModule->list(); // returns all users with data

	$userModule->detail('admin'); // returns selected user with data

	$userModule->changePassword('admin', 'otherPa$$word');

	$userModule->add('other_user', 'pa$$word', '[email protected]');

	$userModule->delete('other_user');

	// ... etc

	```

	

	b) web module

	```php

	$webModule = $client->getModuleWeb('admin'); // web module needs user

	$webModule->listDomains();

	$webModule->addDomain('domain.com');

	$webModule->addDomainLetsEncrypt('domain.com', 'www.domain.com'); // needs longer timeout

	$webModule->deleteDomainLetsEncrypt('domain.com');

	$webModule->addDomainFtp('domain.com', 'test', 'pa$$word');

	$webModule->changeDomainFtpPassword('domain.com', 'admin_test', 'otherPa$$word');

	$webModule->changeDomainFtpPath('domain.com', 'admin_test', 'path/other');

	$webModule->deleteDomainFtp('domain.com', 'admin_test');

	$webModule->deleteDomain('domain.com');

	// ... etc

	```

	

	c) mail module

	```php

	$mailModule = $client->getModuleMail('admin'); // mail module needs user

	$mailModule->listDomains(); // returns mail domains from selected user

	$mailModule->addDomain('domain.com'); // add domain

	$mailModule->listAccounts('domain.com'); // returns accounts from selected user and domain

	$mailModule->listDomainDkim('domain.com'); 

	$mailModule->listDomainDkimDns('domain.com');

	$mailModule->addAccount('domain.com', 'info', 'pa$$word'); // add [email protected] account

	$mailModule->changeAccountPassword('domain.com', 'info', 'otherPa$$word'); // change [email protected] password

	$mailModule->deleteAccount('domain.com', 'info');

	$mailModule->deleteDomain('domain.com');

	// ... etc

	```

	

	d) db module

	```php

	// modules

	$dbModule = $client->getModuleDb(); 

	// todo

	// ... etc

	```

	

	e) cron module

	```php

	$cronModule = $client->getModuleCron(); 

	// todo

	// ... etc

	```

	

	f) backup module

	```php

	$backupModule = $client->getModuleBackup(); 

	// todo

	// ... etc

	```

## Buy us a coffee <3

[![Buy me a Coffee](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=E8NK53NGKVDHS)

## Donate us <3

```

ETH: 0x7D771A56735500f76af15F589155BDC91613D4aB

UBIQ: 0xAC08C7B9F06EFb42a603d7222c359e0fF54e0a13

```