PHP WHMCS CreateOrUpdateTLD用法及代碼示例

創建或更新 TLD 擴展。如果存在 TLD，則將更新現有記錄。如果沒有，將創建一個新的 TLD。允許配置 TLD 相關的銷售參數、定價、寬限期和顯示順序。可以以任何有效貨幣提供定價，並將自動轉換為 WHMCS 安裝中的所有有效貨幣。

請求參數

參數	類型	說明	必需的
action	string	“CreateOrUpdateTLD”	Required
extension	string	添加或更新的擴展名，例如：.com、.net 等……	Required
id_protection	bool	為擴展程序提供 ID 保護	Optional
dns_management	bool	為擴展提供 DNS 管理	Optional
email_forwarding	bool	為擴展程序提供電子郵件轉發	Optional
epp_required	bool	域名轉移是否需要 EPP	Optional
auto_registrar	string	擴展程序應在付款時自動注冊的活躍注冊商	Optional
group	string	指定組標簽。 “HOT”、“NEW”或“SALE”之一。留空為無。	Optional
currency_code	string	定價所用的貨幣代碼。在定義定價、寬限費或贖回費時需要。價格將轉換為所有活躍貨幣。貨幣必須存在於目標 WHMCS 安裝中，並使用匯率進行配置。	Optional
grace_period_days	int	寬限期的天數	Optional
grace_period_fee	float	延期的寬限期費用。 -1 將禁用寬限期	Optional
redemption_period_days	int	贖回天數	Optional
redemption_period_fee	float	延期的贖回期費用。 -1 將禁用贖回期	Optional
register	array	一係列注冊定價。有關格式，請參見下麵的示例。	Optional
renew	array	一係列續訂定價。有關格式，請參見下麵的示例。任何延期的最長續訂期為 9 年。	Optional
transfer	array	一係列轉讓定價。有關格式，請參見下麵的示例。隻能定義最短注冊周期的傳輸。	Optional
display_after	string	可用於修改 TLD 顯示順序。指定此 TLD 應遵循的現有 TLD。	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
extension	string	已創建或更新的擴展
id	int	數據庫中擴展程序的唯一 ID。

示例請求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'CreateOrUpdateTLD',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'extension' => '.com',
            'id_protection' => true,
            'dns_management' => true,
            'email_forwarding' => true,
            'epp_required' => true,
            'auto_registrar' => 'enom',
            'currency_code' => 'USD',
            'grace_period_days' => '0',
            'grace_period_fee' => '-1',
            'redemption_period_fee' => '75.00',
            'register[1]' => '10',
            'register[2]' => '20',
            'register[3]' => '30',
            'register[4]' => '40',
            'register[5]' => '50',
            'register[6]' => '60',
            'register[7]' => '70',
            'register[8]' => '80',
            'register[9]' => '90',
            'register[10]' => '100',
            'renew[1]' => '10',
            'renew[2]' => '20',
            'renew[3]' => '30',
            'renew[4]' => '40',
            'renew[5]' => '50',
            'renew[6]' => '60',
            'renew[7]' => '70',
            'renew[8]' => '80',
            'renew[9]' => '90',
            'transfer[1]' => '10',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'CreateOrUpdateTLD';
$postData = array(
    'extension' => '.com',
    'id_protection' => true,
    'dns_management' => true,
    'email_forwarding' => true,
    'epp_required' => true,
    'auto_registrar' => 'enom',
    'currency_code' => 'USD',
    'grace_period_days' => '0',
    'grace_period_fee' => '-1',
    'redemption_period_fee' => '75.00',
    'register[1]' => '10',
    'register[2]' => '20',
    'register[3]' => '30',
    'register[4]' => '40',
    'register[5]' => '50',
    'register[6]' => '60',
    'register[7]' => '70',
    'register[8]' => '80',
    'register[9]' => '90',
    'register[10]' => '100',
    'renew[1]' => '10',
    'renew[2]' => '20',
    'renew[3]' => '30',
    'renew[4]' => '40',
    'renew[5]' => '50',
    'renew[6]' => '60',
    'renew[7]' => '70',
    'renew[8]' => '80',
    'renew[9]' => '90',
    'transfer[1]' => '10',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例響應 JSON

{
    "result": "success",
    "extension": ".com",
    "id": "1"
}

錯誤響應

可能的錯誤條件響應包括：

• 需要延期
• 無活動注冊器 - 無法定義 auto_registrar 值
• auto_registrar 值無效。必須為空或以下之一：enom、resellerclub...
• 定義定價時需要變量currency_code
• 假設 currency_code 值不存在。必須是以下之一：美元、英鎊……
• 參數 register、renew 和 transfer 必須是數組
• 最長注冊期限為10年
• 最長續訂期為 9 年
• 隻能定義一個傳輸周期
• 最長轉讓期限為10年
• 無效的組參數：GROUP。應該是 HOT、NEW、SALE 之一