updaterbot/runcloud-sdk

RunCloud PHP SDK (非官方)

维护者

详细信息

github.com/updaterbot/runcloud-sdk

源代码

安装: 24

依赖: 1

建议者: 0

安全: 0

星标: 1

关注者: 0

分支: 8

1.1.1 2023-04-27 05:13 UTC

Requires

MIT 320cbecd58da8cabeaccb89381fa4d40226be261

  • Pier Trapani <hello.woop@16bit.it>
  • Craig Rodway <code.woop@onhover.co.uk>
  • Bicsakszerk <bicsakszerk.woop@gmail.com>

apisdkruncloud

This package is not auto-updated.

Last update: 2024-09-27 10:20:09 UTC

README

此SDK帮助您调用RunCloud版本2 API的所有API调用，并且是基于RunCloud PHP SDK的分支。

RunCloud API文档

安装

使用Composer安装SDK到您的项目中

composer require updaterbot/runcloud-sdk

使用Composer的自动加载

require __DIR__ . '/../vendor/autoload.php';

创建SDK的实例

$runcloud = new OnHover\RunCloud\RunCloud('MY_API_KEY', 'MY_API_SECRET');

用法

您可以使用$runcloud实例进行所有可用的API调用。

要了解所有可用的方法，检查Actions目录中相应的类。这些类的名称和函数紧密遵循RunCloud API文档。

示例

$response = $runcloud->ping();

此测试API的连接，应返回字符串"pong"。

$servers = $runcloud->servers();

这将返回您可访问的服务器数组。数组中的每个项都将是一个OnHover\RunCloud\Resources\Server的实例，并包含各种属性，如id、name、provider和ipAddress。

您可以像这样返回单个服务器实例

$serverId = 12345;
$server = $runcloud->server($serverId);

某些方法需要将参数作为数组提供。

$serverId = 12345;

$data = [
	'type' => 'global',
	'port' => '8080-8081',
	'protocol' => 'tcp',
];

$rule = $runcloud->createFirewallRule($serverId, $data);

安全

如果您发现任何安全相关的问题，请通过电子邮件code@onhover.co.uk联系，而不是使用问题跟踪器。

鸣谢

此包使用Forge SDK包和Mohammed Said的灵感，并受到Oh Dear PHP SDK包的启发。

许可

MIT许可证（MIT）。请参阅许可文件以获取更多信息。