PHP WHMCS GetAffiliates用法及代码示例

获得一系列附属机构

请求参数

参数	类型	说明	必需的
action	string	“GetAffiliates”	Required
limitstart	int	返回的附属数据的偏移量(默认值：0)	Optional
limitnum	int	返回的记录数(默认：25)	Optional
userid	int	获取特定客户帐户的会员数据	Optional
visitors	int	提供与特定访客数量相匹配的附属公司	Optional
paytype	string	提供与提供的支付类型相匹配的附属公司。 “，‘percentage’, ‘fixedamount’之一	Optional
payamount	float	提供与特定覆盖支付数量匹配的关联公司	Optional
onetime	int	提供配置为接收一次性会员的会员	Optional
balance	float	提供有此余额的附属公司	Optional
withdrawn	float	提供已提取此数量的关联公司	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
totalresults	int	可用结果总数
startnumber	int	返回结果的起始编号
numreturned	int	返回的结果数
affiliates	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' => 'GetAffiliates',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'GetAffiliates';
$postData = array(
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "totalresults": "2",
    "startnumber": "0",
    "numreturned": "2",
    "affiliates[affiliate][0][id]": "1",
    "affiliates[affiliate][0][date]": "2016-01-01",
    "affiliates[affiliate][0][clientid]": "1",
    "affiliates[affiliate][0][visitors]": "145",
    "affiliates[affiliate][0][paytype]": "percentage",
    "affiliates[affiliate][0][payamount]": "15.00",
    "affiliates[affiliate][0][onetime]": "1",
    "affiliates[affiliate][0][balance]": "15.00",
    "affiliates[affiliate][0][withdrawn]": "0.00",
    "affiliates[affiliate][0][created_at]": "0000-00-00 00:00:00",
    "affiliates[affiliate][0][updated_at]": "0000-00-00 00:00:00",
    "affiliates[affiliate][1][id]": "1",
    "affiliates[affiliate][1][date]": "2016-01-08",
    "affiliates[affiliate][1][clientid]": "4",
    "affiliates[affiliate][1][visitors]": "0",
    "affiliates[affiliate][1][paytype]": "",
    "affiliates[affiliate][1][payamount]": "0.00",
    "affiliates[affiliate][1][onetime]": "1",
    "affiliates[affiliate][1][balance]": "0.00",
    "affiliates[affiliate][1][withdrawn]": "0.00",
    "affiliates[affiliate][1][created_at]": "0000-00-00 00:00:00",
    "affiliates[affiliate][1][updated_at]": "0000-00-00 00:00:00"
}