PHP WHMCS UpdateOAuthCredential用法及代碼示例

更新給定的 OAuth API 客戶端憑據。

請求參數

參數	類型	說明	必需的
action	string	“UpdateOAuthCredential”	Required
credentialId	int	要更新的憑證集的自增 ID	Required
clientApiIdentifier	string	要更新的 OAuth API 客戶端憑據唯一標識符(客戶端 ID)。僅當 credentialId 未知/未通過時才需要。	Optional
name	string	要分配的名稱	Optional
description	string	要分配的說明	Optional
grantType	string	憑證集對其有效的授權類型。可能的值包括：authorization_code 或 single_sign_on	Optional
scope	string	憑據集對其有效的範圍的空格分隔列表。看CreateOAuthCredential對於允許值	Optional
serviceId	int	憑證相關的服務 ID	Optional
logoUri	string[]	he logoUri 分配	Optional
redirectUri	string	一組授權重定向 URI	Optional
resetSecret	bool	設置為 true 以重置 OAuth API 客戶端憑據密碼	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
credentialId	int	憑據集的自動增量 ID
newClientSecret	string	僅當 resetSecret 作為 true 傳遞時才存在

示例請求 (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' => 'UpdateOAuthCredential',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'credentialId' => '1',
            'name' => 'Credential name',
            'resetSecret' => true,
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'UpdateOAuthCredential';
$postData = array(
    'credentialId' => '1',
    'name' => 'Credential name',
    'resetSecret' => true,
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success",
    "credentialId": "1",
    "newClientSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

錯誤響應

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

• 需要憑據 ID 或客戶端標識符。
• 提供的憑據 ID 無效。
• 提供的客戶端標識符無效。
• 請求的授權類型“xxxxx” 無效。
• 需要客戶端憑據的名稱。
• 單個 sign-on 授權類型需要服務 ID。
• 請求的範圍 “xxxxxxx” 無效。