1
0
mirror of https://github.com/ovh/php-ovh.git synced 2023-11-05 03:20:26 +01:00

Add documentation about HTTP client library injection

Signed-off-by: Vincent Casse <vincent.casse@corp.ovh.com>
This commit is contained in:
Vincent Casse 2015-12-15 18:16:11 +01:00
parent 3f9aec3547
commit d99c758c72

View File

@ -124,6 +124,40 @@ foreach ($servers as $server) {
?>
```
How to customize HTTP client configuration?
-------------------------------------------
You can inject your own HTTP client with your specific configuration. For instance, you can edit user-agent and timeout for all your requests
```php
<?php
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;
use GuzzleHttp\Client;
// Informations about your application
$applicationKey = "your_app_key";
$applicationSecret = "your_app_secret";
$consumer_key = "your_consumer_key";
// Information about API and rights asked
$endpoint = 'ovh-eu';
$client = new Client();
$client->setDefaultOption('timeout', 1);
$client->setDefaultOption('headers', array('User-Agent' => 'api_client') );
// Get servers list
$conn = new Api( $applicationKey,
$applicationSecret,
$endpoint,
$consumer_key,
$client);
$webHosting = $conn->get('/hosting/web/');
foreach ($webHosting as $webHosting) {
echo "One of our web hosting: " . $webHosting . "\n";
```
How to build the documentation?
-------------------------------