README

domains.co.za 代理商 API 的 PHP 客户端。

一个功能齐全的 PHP 客户端，用于与 domains.co.za 代理商 API 一起使用。这是一个全新的项目，仍在开发中。它不应在生产环境中使用。在达到 1.0 版本之前，它可能会发生重大变化。

您需要有一个活跃的 domains.co.za 代理商账户。您需要提供您的用户名和密码以生成新的认证令牌，或者如果您已经有了令牌，您也可以提供该令牌。请注意，此库不支持双因素认证。

安装

目前还没有版本，所以您需要确保您的 composer.json 文件已设置 "minimum-stability": "dev"。

Names 库没有绑定到任何 HTTP 客户端库，您可以安装任何 PSR-7、PST-17 和 PSR-18 兼容的库。一个好的起点可以是

composer require thepublicgood/names guzzlehttp/guzzle php-http/guzzle7-adapter

使用方法

创建一个 Names 类的新实例，并传入您的令牌（如果您有）。否则，您可以将用户名和密码传递给 authenticate 方法

$names = new \TPG\Names\Names(token: $token);

// or

$names = new \TPG\Names\Names();
$auth = $names->authenticate($username, $password);

$token = $auth->token;

代理商对象

许多响应将包括一个 Reseller 对象

$reseller = $response->reseller;

$reseller->username;        // string
$reseller->balance;         // float
$reseller->accountType;     // string
$reseller->lowBalance;      // bool

域名

检查域名是否可用

$check = $names->domains()->check('is-this-available.com');

$check->requiresEpp;    // bool
$check->isAvailable;    // bool
$check->eppKey;         // string
$check->tld;            // string
$check->sld;            // string
$check->isPremium;      // bool
$check->reseller;       // Reseller object

获取注册域名列表

$list = $names->domains()->list();

// or

// Get a list of expired domains
$names->domains()->expired();

// Get a list of domains expiring next month
$names->domains()->expiringNextMonth();

// Get a list of suspended domains
$names->domains()->suspended();

// Get a list of domains currently in redemption
$names->domains()->redemption();

返回的每个域名都是一个 Domain 对象

$domain = $names->domains()->list()->first();

$domain->name;              // string
$domain->contactName;       // string
$domain->contactId;         // string
$domain->status;            // string
$domain->eppStatus;         // string
$domain->premiumDns;        // bool
$domain->createdAt;         // Carbon
$domain->expiresAt;         // Carbon
$domain->redemptionDate;    // Carbon
$domain->deletionDate;      // Carbon
$domain->autoRenew;         // bool
$domain->externalReference; // string
$domain->nameservers;       // array

积分

• Warrick Bayman

许可协议

MIT 许可协议（MIT）。有关更多详细信息，请参阅 LICENSE.md 文件。