hypernode/api-client

PHP Hypernode API 客户端

0.4.2 2024-04-29 07:15 UTC

This package is auto-updated.

Last update: 2024-08-29 08:03:51 UTC


README

请注意:此项目仍处于早期阶段,API 可能会发生变化。

安装

composer require hypernode/api-client

API 客户端对 HTTP 客户端无关,这意味着它与实现 PSR-18 接口 的任何 HTTP 客户端兼容。

流行的 HTTP 客户端实现包括: GuzzleSymfony HTTP Client

完整实现列表可以在 这里找到

使用方法

获取 API 令牌

每个 Hypernode 都有一个与之关联的 API 令牌,您可以使用它直接与 API 通信。您可以在 /etc/hypernode/hypernode_api_token 中找到令牌。有关具有特殊权限的 API 令牌,请联系 support@hypernode.com

使用客户端

use Hypernode\Api\HypernodeClientFactory;

require_once 'vendor/autoload.php';

$client = HypernodeClientFactory::create(getenv('HYPERNODE_API_TOKEN'));

// For the Hypernode `johndoe` PHP version to 8.1 and Node.js version to 18
$job = $client->settings->setBatch('johndoe', [
    'php_version' => '8.1',
    'nodejs_version' => '18'
]);

// If something has changed, wait for the changes to be applied.
while ($job && !$job->completed()) {
    sleep(2);
    $job->refresh();
}

支持的功能

以下是客户端实现的 Hypernode API 功能列表。

  • 列出与您的 API 密钥相关的 Hypernode
  • 一次性更新一个或多个 Hypernode 设置。
  • 查询/轮询作业状态。
  • 列出、创建、更新和取消 Brancher Hypernode 实例。

相关项目