从HttpWebRequest迁移到HttpClient调用Verizon ThingSpace OAuth接口遇问题

问题描述 #

我正在使用Verizon ThingSpace API生成OAuth令牌，API文档提供的curl示例如下：

curl -X POST -d "grant_type=client_credentials" -H "Authorization: Basic BASE64_ENCODED_APP_KEY_AND_SECRET" -H "Content-Type: application/x-www-form-urlencoded" "/api/ts/v1/oauth2/token"

用旧版HttpWebRequest可以成功复现该请求，但改用HttpClient时返回错误：

{"error":"invalid_request","error_description":"Invalid grant_type parameter or parameter missing"}

可正常运行的HttpWebRequest实现 #

public static void API_Login()
{
    Console.WriteLine("API Request ----------------------------------");
    string url = @"https://thingspace.verizon.com/api/ts/v1/oauth2/token";
    var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);
    httpWebRequest.Method = "POST";
    httpWebRequest.ContentType = "application/x-www-form-urlencoded";
    httpWebRequest.Headers.Add("Authorization", $"Basic {encodedKeyAndSecret}");
    var body = "grant_type=client_credentials";
    var data = Encoding.ASCII.GetBytes(body);
    httpWebRequest.ContentLength = data.Length;

    using (var stream = httpWebRequest.GetRequestStream())
    {
        stream.Write(data, 0, data.Length);
    }

    var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
    using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
    {
        var result = streamReader.ReadToEnd();
        JsonObject jsonObject = (JsonObject)JsonObject.Parse(result);
        apiToken = jsonObject["access_token"].ToString();
    }
}

无法正常运行的HttpClient实现 #

public async static void HttpClient_API_Login(string encodedKeyAndSecret)
{
    string url = @"https://thingspace.verizon.com/api/ts/v1/oauth2/token";
    var client = new HttpClient();
    var body = "grant_type=client_credentials";
    var request = new HttpRequestMessage()
    {
        Method = HttpMethod.Post,
        RequestUri = new Uri(url),
        Headers =
        {
            { HttpRequestHeader.ContentType.ToString(), $"application/x-www-form-urlencoded" },
            { HttpRequestHeader.Authorization.ToString(), $"Basic {encodedKeyAndSecret}" },
        },
        Content = new StringContent(body)
    };

    var response = client.SendAsync(request).Result;
    var sr = await response.Content.ReadAsStringAsync();
    Console.WriteLine("response: " + sr);
}

问题原因 #

你的HttpClient实现存在两个关键错误：

• Content-Type头设置错误：你将Content-Type添加到了Headers集合中，但StringContent默认会自带text/plain; charset=utf-8的Content-Type头，二者冲突导致服务端无法正确解析表单数据。
• 请求体编码不匹配：StringContent默认使用UTF-8编码，但你原有的HttpWebRequest使用的是ASCII编码，虽然这不是核心问题，但保持编码一致能避免潜在兼容问题。

修正后的HttpClient实现 #

public async static Task HttpClient_API_Login(string encodedKeyAndSecret)
{
    string url = @"https://thingspace.verizon.com/api/ts/v1/oauth2/token";
    using var client = new HttpClient();
    
    // 设置Authorization请求头
    client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", encodedKeyAndSecret);
    
    // 用FormUrlEncodedContent构建表单内容，自动处理编码和Content-Type头
    var formContent = new FormUrlEncodedContent(new[]
    {
        new KeyValuePair<string, string>("grant_type", "client_credentials")
    });
    
    var response = await client.PostAsync(url, formContent);
    var sr = await response.Content.ReadAsStringAsync();
    Console.WriteLine("response: " + sr);
}

额外优化说明 #

• 替换async void为async Task，这是C#异步编程的最佳实践，可避免线程泄漏等潜在问题。
• 使用FormUrlEncodedContent代替手动拼接字符串，它会自动处理URL编码和Content-Type设置，减少手动错误。
• 用using语句管理HttpClient实例，确保资源正确释放（生产环境推荐复用单例HttpClient，简单场景下using也能满足需求）。

基于原代码的轻量修正版本 #

如果你想在原有代码基础上调整，只需修正Content-Type的设置方式：

public async static Task HttpClient_API_Login(string encodedKeyAndSecret)
{
    string url = @"https://thingspace.verizon.com/api/ts/v1/oauth2/token";
    using var client = new HttpClient();
    var body = "grant_type=client_credentials";
    
    // 正确设置StringContent的编码和Content-Type
    var content = new StringContent(body, Encoding.ASCII, "application/x-www-form-urlencoded");
    
    var request = new HttpRequestMessage(HttpMethod.Post, url)
    {
        Headers =
        {
            { HttpRequestHeader.Authorization.ToString(), $"Basic {encodedKeyAndSecret}" },
        },
        Content = content
    };

    var response = await client.SendAsync(request);
    var sr = await response.Content.ReadAsStringAsync();
    Console.WriteLine("response: " + sr);
}

内容的提问来源于stack exchange，提问作者Shawn