PHP WHMCS GetModuleConfigurationParameters用法及代码示例

获取模块配置参数

请求参数

参数	类型	说明	必需的
action	string	“获取模块配置参数”	Required
moduleType	string	要激活的模块类型	Required
moduleName	string	要激活的模块名称	Required

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
parameters	array	可以为给定模块设置的一组配置参数。

示例请求 (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' => 'GetModuleConfigurationParameters',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'moduleType' => 'gateway',
            'moduleName' => 'paypal',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'GetModuleConfigurationParameters';
$postData = array(
    'moduleType' => 'gateway',
    'moduleName' => 'paypal',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "parameters[0][name]": "FriendlyName",
    "parameters[0][displayName]": "FriendlyName",
    "parameters[0][fieldType]": "text",
    "parameters[1][name]": "email",
    "parameters[1][displayName]": "PayPal Email",
    "parameters[1][fieldType]": "text",
    "parameters[2][name]": "forceonetime",
    "parameters[2][displayName]": "Force One Time Payments",
    "parameters[2][fieldType]": "yesno",
    "parameters[3][name]": "forcesubscriptions",
    "parameters[3][displayName]": "Force Subscriptions",
    "parameters[3][fieldType]": "yesno",
    "parameters[4][name]": "requireshipping",
    "parameters[4][displayName]": "Require Shipping Address",
    "parameters[4][fieldType]": "yesno",
    "parameters[5][name]": "overrideaddress",
    "parameters[5][displayName]": "Client Address Matching",
    "parameters[5][fieldType]": "yesno",
    "parameters[6][name]": "apiusername",
    "parameters[6][displayName]": "API Username",
    "parameters[6][fieldType]": "text",
    "parameters[7][name]": "apipassword",
    "parameters[7][displayName]": "API Password",
    "parameters[7][fieldType]": "text",
    "parameters[8][name]": "apisignature",
    "parameters[8][displayName]": "API Signature",
    "parameters[8][fieldType]": "text",
    "parameters[9][name]": "sandbox",
    "parameters[9][displayName]": "Sandbox Mode",
    "parameters[9][fieldType]": "yesno"
}

错误响应

可能的错误条件响应包括：

• 提供的模块类型无效。支持的模块类型包括：xxx
• 提供的模块名称无效。
• 获取模块类型不支持的模块配置参数。
• 发生意外错误：xxx