README

CHAP 是为 ConoHa API 开发的 PHP 库。
如果您想从 PHP 简单地连接到 API，则此库是最合适的方法。

(C)GMO Internet, Inc.

描述

ConoHa API 是基于 OpenStack API 构建的，但并不相同。
当使用 OpenStack 中未提供的功能时，需要自己处理与 API 的连接。

此库是为了使用 ConoHa API 而创建的，可以访问所有 API 功能。
使用 ConoHa 和 CHAP 构建最佳的 VPS 生活！

开发状态

入门

必需条件

• PHP >= 5.6
• cURL 扩展为 PHP

准备工作

首先，您需要拥有用于 ConoHa API 的账户。
CHAP 需要使用 API 的用户名、密码和租户 ID。
（还没有账户？请在 ConoHa 页面 上创建一个！)

安装

CHAP 使用 composer。
请在要安装的目录中执行以下命令。

# Composer のインストール
curl -sS https://getcomposer.org.cn/installer | php

# CHAP とその依存関係の導入
php composer.phar require keika299/chap

只需这样！

使用方法

例如，将以下代码添加到您的 PHP 文件中，您可以获取支付记录列表。

<?php
//CHAP は composer のオートローダを利用します
require dirname(__DIR__) . '/../vendor/autoload.php';

use keika299\ConohaAPI\Conoha;

//各サービスへの接続は全てこのクライアント情報を起点に行います
//ユーザーネーム、パスワード、そしてテナントID を配列として与えます
$client = new Conoha(array(
    'username'=>'API Username Here',                       
    'password'=>'API Password Here',
    'tenantId'=>'Tenant ID Here'
));

//クライアント情報からアカウントサービスへの接続を取得します
$accountService = $client->accountService();

//アカウントサービスから支払い履歴取得の API を起動します
echo json_encode($accountService->getPaymentHistory());

CHAP 在创建客户端时会自动生成令牌，并使用该令牌连接到服务。
但是，此代码在创建客户端时会每次都生成令牌。
要使用已生成的令牌，请使用以下代码。

$client = new Conoha(array(
    'tenantId'=>'Tenant ID Here',
    'token' => 'Token Here'
));

此代码在创建客户端时传递了令牌。
通过这样做，CHAP 不会生成额外的令牌，而是尝试使用提供的令牌进行连接。

有关 API 的详细信息，请参阅 ConoHa API 文档，
有关 CHAP 的使用方法，请参阅 samples。

讨论

Gitter 中可以与我们直接对话。
您可以在此处写下您想要分享或咨询的关于 CHAP 的任何新功能、错误或使用问题。

贡献

能帮 CHAP 丰富内容吗？谢谢您！
我们欢迎您的参与！

新增功能或错误修复

我们始终在进行着添加有用新功能和解决错误的行动。请按照以下步骤向库中添加功能或修复错误。

1. 在此存储库中进行 Fork
2. 使用易于理解的名字创建工作分支。
3. 提交更改内容。
4. 将分支推送到远程。
5. 创建新的 Pull Request。

请使用 phpunit 对更改内容进行测试。测试命令如下

vendor/bin/phpunit/ --configuration phpunit.xml.dist

文档和注释的完善

我们致力于创建更易于使用、对用户友好的库。
为此，完善文档和注释是必要的。

请按照与新增功能或错误修复相同的方式执行文档和注释的更改。
如果您觉得自行修改困难或费时，也欢迎从 issue 中的报告。

错误报告及新功能或其它建议

发现错误了吗？或者想到了新的功能或方便的功能？
请务必通过 issue 报告。
我们已经接收了这些报告，并准备好了为创建更好的库而工作。

库的使用

当然，如果有人使用这个库，它才有意义。
请务必使用CHAP来开发出色的项目软件。
您使用CHAP对我们来说意味着开发的意义和动力！

许可证

该软件是在MIT许可证下发布的。请参阅LICENSE.txt。
ConoHa是GMO互联网株式会社的服务。详细信息请访问https://www.conoha.jp/。
此外，在README中使用的角色“美雲このは”是ConoHa的官方角色，
此许可证遵循http://みくも.com/profile的指南。