proprietes-privees/ovh

OVH API 的包装器

维护者

详细信息

github.com/proprietes-privees/ovh

源代码

问题

安装: 12

依赖项: 0

建议者: 0

安全: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

1.0 2016-02-02 09:35 UTC

Requires

Requires (Dev)

BSD-3-Clause bedada62207a1c0dbd903fa8d44af0825ef59527

  • Vincent Cassé

This package is not auto-updated.

Last update: 2024-09-20 09:54:33 UTC

README

PHP Wrapper for OVH APIs

此 PHP 包是一个轻量级的 OVH API 包装器。这是在 PHP 应用程序中使用 OVH.com API 的最简单方法。

Build Status HHVM Status

<?php
/**
 * # Instantiate. Visit https://api.ovh.com/createToken/index.cgi?GET=/me
 * to get your credentials
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

$ovh = new Api( $applicationKey,
                $applicationSecret,
                $endpoint_name,
                $consumer_key);
echo "Welcome " . $ovh->get('/me')['firstname'];
?>

快速入门

要下载此包装器并将其集成到您的 PHP 应用程序中，您可以使用 Composer。

在您的 composer.json 文件中添加存储库，或者如果您还没有此文件，可以在项目根目录中创建它，内容如下

{
    "name": "Example Application",
    "description": "This is an example of OVH APIs wrapper usage",
    "require": {
        "ovh/ovh": "dev-master"
    }
}

然后，您可以使用以下命令安装 OVH API 包装器和依赖项

php composer.phar install

这将安装 ovh/ovh 到 ./vendor，包括 autoload.php 在内的其他依赖项。

如何以用户身份登录？

为了与 API 通信，SDK 在每个请求中使用一个 token 来识别用户。这个 token 被称为 消费者密钥。要有一个经过验证的 消费者密钥，您需要将您的用户重定向到特定的认证页面。一旦用户登录，token 就会被验证，并且用户将被重定向到 $redirection URL。

<?php
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

session_start();

// Informations about your application
$applicationKey = "your_app_key";
$applicationSecret = "your_app_secret";
$redirection = "http://your_url.ovh";

// Information about API and rights asked
$endpoint = 'ovh-eu';
$rights = array( (object) [
    'method'    => 'GET',
    'path'      => '/me*'
]);

// Get credentials
$conn = new Api($applicationKey, $applicationSecret, $endpoint);
$credentials = $conn->requestCredentials($rights, $redirection);

// Save consumer key and redirect to authentication page
$_SESSION['consumer_key'] = $credentials["consumerKey"];
header('location: '. $credentials["validationUrl"]);
...
?>

如何使用 OVH API 在 SBG1 服务器上启用网络突发？

<?php
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

// 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';

// Get servers list
$conn = new Api(    $applicationKey,
                    $applicationSecret,
                    $endpoint,
                    $consumer_key);
$servers = $conn->get('/dedicated/server/');

foreach ($servers as $server) {

    // Search servers inside SBG1
    $details = $conn->get('/dedicated/server/'. $server);
    if ($details['datacenter'] == 'sbg1') {

        // Activate burst on server
        $content = (object) array('status' => "active");
        $conn->put('/dedicated/server/'. $server . '/burst', $content);
        echo "We burst " . $server;
    }
}

?>

如何构建文档？

文档基于 phpdocumentor。要与其他质量工具一起安装它，您可以在克隆的项目中安装本地 npm 项目

git clone https://github.com/ovh/php-ovh.git
cd php-ovh
php composer.phar install
npm install

要生成文档，可以直接使用

grunt default

文档位于 docs/ 目录中。

如何运行测试？

测试基于 phpunit。要与其他质量工具一起安装它，您可以在克隆的项目中安装本地 npm 项目

git https://github.com/ovh/php-ovh.git
cd php-ovh
php composer.phar install
npm install

使用您的凭据编辑 phpunit.xml 文件以通过功能测试。然后，您可以使用 grunt 直接运行单元和功能测试。

grunt

支持的 API

OVH 欧洲

OVH 北美

So you Start 欧洲

So you Start 北美

Kimsufi 欧洲

Kimsufi 北美

Runabove

相关链接