mirror of
https://github.com/envoyr/php-froxlor-client.git
synced 2026-04-28 12:24:08 +00:00
Update README.md
This commit is contained in:
20
README.md
20
README.md
@@ -2,19 +2,27 @@
|
|||||||
|
|
||||||
API Wrapper for Froxlor.
|
API Wrapper for Froxlor.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
You can install it via composer:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ composer require envoyr/php-froxlor-client
|
||||||
|
```
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
````
|
```php
|
||||||
$froxlor = new \Envoyr\Froxlor\Server([
|
$froxlor = new \Envoyr\Froxlor\Server([
|
||||||
'host' => 'https://froxlor.example.com',
|
'host' => 'https://froxlor.example.com',
|
||||||
'key' => '',
|
'key' => '',
|
||||||
'secret' => ''
|
'secret' => ''
|
||||||
]);
|
]);
|
||||||
````
|
```
|
||||||
|
|
||||||
### Customer
|
### Customer
|
||||||
|
|
||||||
````
|
```php
|
||||||
$response = $froxlor
|
$response = $froxlor
|
||||||
->customers
|
->customers
|
||||||
->create([
|
->create([
|
||||||
@@ -29,16 +37,16 @@ $response = $froxlor
|
|||||||
'api_allowed' => false,
|
'api_allowed' => false,
|
||||||
'createstdsubdomain' => true,
|
'createstdsubdomain' => true,
|
||||||
]);
|
]);
|
||||||
````
|
```
|
||||||
|
|
||||||
### Email
|
### Email
|
||||||
|
|
||||||
````
|
```php
|
||||||
$response = $froxlor
|
$response = $froxlor
|
||||||
->customer('example')
|
->customer('example')
|
||||||
->email('hello@example.com')
|
->email('hello@example.com')
|
||||||
->attributes;
|
->attributes;
|
||||||
````
|
```
|
||||||
|
|
||||||
### Info
|
### Info
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user