chrometoaster/sitehost-api-client

SiteHost API 的 PHP 客户端

0.2.0 2020-02-18 03:39 UTC

This package is auto-updated.

Last update: 2024-09-18 13:51:35 UTC


README

概览

这是一段正在开发中的代码,可能需要根据需要进一步扩展。

API 文档

SiteHost API 文档

功能

  • 获取 API 信息
  • 获取云栈信息
  • 更新云栈信息
  • 获取 API 任务信息

安装

composer install chrometoaster/sitehost-api-client:~0.1

示例用法

建议将 API 密钥和客户端 ID 定义为环境变量,例如通过您的云容器环境变量配置或通过您的虚拟主机配置。

use Chrometoaster\SiteHost\API\Client as SiteHostAPIClient;

$env_api_key   = getenv('SITEHOST_API_KEY');
$env_client_id = getenv('SITEHOST_CLIENT_ID');

// create a client
$client = new SiteHostAPIClient($env_api_key, $env_client_id);

// read cloud stack info
$info = $client->getStackInfo('ex-myserver', 'abc123def456ab12');

// check the response is valid and has data
if ($info->isValid()) {
    // work with the information here
    ...
    ... 
}

待办事项

  • 实现其他 API 端点的方法和处理
  • 添加测试。

许可证

BSD-3-Clause,有关详细信息,请参阅许可证

贡献

一般来说,请互相友好。有关更多详细信息,请参阅行为准则

代码规范

本项目遵循以下标准中定义的标准

在提交 PR 之前,请运行以下脚本来检查并更新代码,以符合上述标准。

composer run full-check