Files
php-froxlor-client/README.md
2024-12-08 12:17:51 +01:00

1.1 KiB

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:

$ composer require envoyr/php-froxlor-client

How to use

$froxlor = new \Envoyr\Froxlor\Server([
    'host' => 'https://froxlor.example.com',
    'key' => '',
    'secret' => ''
]);

Customer

$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

$response = $froxlor
    ->customer(1)
    ->email(1)
    ->attributes;

Info

Domains, Ftps, Email & EmailAccounts are also available.