hipex/pack-api

该软件包已被弃用且不再维护。没有建议替代软件包。

围绕 Hipex 托管平台 API 的包装器

v1.51.0 2021-07-02 18:29 UTC

README

此项目已结束生命周期,将不再维护或更新。请考虑使用 https://platform-api.hipex.io/

PackApi

围绕 Hipex 托管平台 API 的包装器。请查看 https://www.hipex.io/。此库的大部分内容是从 https://service.hipex.io/hipex-pack-api GraphQL 端点生成的。

有关更详细的文档和 API 探索器,请查看 https://service.hipex.io/hipex-pack-api/docs/

安装

需要实现 psr/log-implementation。对于 Magento 2,monolog/monolog 已安装。

composer require hipex/pack-api

使用方法

首次使用时需要登录。这将存储令牌在您的家目录 (~/.hipex-console-auth) 或指定的令牌文件中。登录后,您可以调用查询和突变。如果首次调用查询而不登录,API 将无结果返回或在突变时抛出异常。

登录

$client = new \HipexPackApi\Client();
$client->login('info@example.com', 'password');

调用查询/突变 在此示例中,我们将获取所有服务器的列表,并为每个服务器获取服务器上的域名。使用 GraphQL API 包装器进行相同的 API 调用有一个更有效的方法。有关此内容,请参阅扩展的 API 文档。

$servers = $client->queryServer();
foreach ($servers as $server) {
    $filter = new \HipexPackApi\Generated\Schema\Input\FilterInput();
    $filter->setField('server.id');
    $filter->value($server->getId());
    
    $domains = $client->queryDomain($filter);    
} 

运行 GraphQL 查询

$query = '
query Server {
    Server {
        id
        name
        domains {
            id
            domain
            letsEncryptSsl
            backup
        }
    }
}
';
$serversAndDomains = $client->raw($query); 

问题

对于问题,请至少包含以下部分

  • 使用的 PHP 版本
  • 重现问题的代码示例
  • 代码的预期结果
  • 代码的实际结果

版本

遵循语义版本控制 (https://semver.org/)。简而言之,给定版本号 MAJOR.MINOR.PATCH,增加

  1. MAJOR 版本 后向兼容的破坏。
  2. MINOR 版本 以向后兼容的方式添加功能
  3. PATCH 版本 错误修复