mirror of
https://github.com/envoyr/php-froxlor-client.git
synced 2026-04-28 04:06:19 +00:00
56 lines
1.1 KiB
Markdown
56 lines
1.1 KiB
Markdown
# PHP Froxlor API Client
|
|
|
|
> [!WARNING]
|
|
> We have changed the way we get the object. Now you have to use the `id` instead of the `name` to get, change or delete the object.
|
|
|
|
API Wrapper for Froxlor.
|
|
|
|
## Installation
|
|
|
|
You can install it via composer:
|
|
|
|
```console
|
|
$ composer require envoyr/php-froxlor-client
|
|
```
|
|
|
|
## How to use
|
|
|
|
```php
|
|
$froxlor = new \Envoyr\Froxlor\Server([
|
|
'host' => 'https://froxlor.example.com',
|
|
'key' => '',
|
|
'secret' => ''
|
|
]);
|
|
```
|
|
|
|
### Customer
|
|
|
|
```php
|
|
$response = $froxlor
|
|
->customers
|
|
->create([
|
|
'email' => 'hello@example.com',
|
|
'firstname' => 'Test',
|
|
'name' => 'Testman',
|
|
'custom_notes' => 'Created By API',
|
|
'customernumber' => 1337,
|
|
'new_loginname' => 'username',
|
|
'new_customer_password' => 'someRandomString',
|
|
'hosting_plan_id' => 1,
|
|
'api_allowed' => false,
|
|
'createstdsubdomain' => true,
|
|
]);
|
|
```
|
|
|
|
### Email
|
|
|
|
```php
|
|
$response = $froxlor
|
|
->customer(1)
|
|
->email(1)
|
|
->attributes;
|
|
```
|
|
|
|
### Info
|
|
|
|
Domains, Ftps, Email & EmailAccounts are also available. |