如何通过API导入CMS开放支付数据？反序列化返回NULL问题排查

一、先确认API请求是否真的拿到数据 #

• 在脚本组件里加日志输出，把API的响应状态码、完整响应体打出来，确认有没有获取到JSON：

  var response = client.GetAsync(apiUrl).Result;
  // 输出状态码，排查是否是4xx/5xx错误
  System.Diagnostics.Debug.WriteLine($"API状态码: {response.StatusCode}");
  // 输出响应内容，看是不是预期的JSON格式
  string responseBody = response.Content.ReadAsStringAsync().Result;
  System.Diagnostics.Debug.WriteLine($"API响应内容: {responseBody}");
  

• 强制指定请求头为JSON格式，有些API默认返回XML，必须显式声明：

  client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
  

• 核对API参数，比如日期范围、分页参数，参数不对可能返回200但空数据集。

二、反序列化代码优化 #

• 确保实体类和JSON字段完全匹配，尤其是大小写差异，用JsonProperty指定映射：

  public class PaymentRecord
  {
      [JsonProperty("payment_id")]
      public string PaymentId { get; set; }
      [JsonProperty("total_amount")]
      public decimal TotalAmount { get; set; }
      // 其他字段对应JSON的key
  }
  

• 别用Result阻塞异步调用，改成await（要把组件方法改成异步），避免异步未完成导致空值：

  public async override void CreateNewOutputRows()
  {
      using (var client = new HttpClient())
      {
          client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
          var response = await client.GetAsync(apiUrl);
          response.EnsureSuccessStatusCode(); // 直接抛出HTTP错误，方便排查
          string responseBody = await response.Content.ReadAsStringAsync();
          var paymentList = JsonConvert.DeserializeObject<List<PaymentRecord>>(responseBody);
          
          if (paymentList != null)
          {
              foreach (var record in paymentList)
              {
                  OutputBuffer.AddRow();
                  OutputBuffer.PaymentId = record.PaymentId;
                  OutputBuffer.TotalAmount = record.TotalAmount;
              }
          }
      }
  }
  

• 如果JSON是嵌套结构（比如{"data": [{}]}），要先定义根类再反序列化：

  public class ApiRoot
  {
      [JsonProperty("data")]
      public List<PaymentRecord> PaymentData { get; set; }
  }
  // 反序列化时
  var root = JsonConvert.DeserializeObject<ApiRoot>(responseBody);
  var paymentList = root?.PaymentData;
  

三、替代方案 #

• 用SSIS自带的JSON源组件：不用写脚本，直接配置API地址、请求头，可视化指定JSON路径提取数据，避免脚本的异步或序列化坑。
• 用Power Query数据源：在SSIS里通过Power Query调用API，它自带JSON解析和结构识别，还能顺便做数据清洗，适合复杂响应。
• 先下载JSON到本地：用脚本或执行进程任务调用PowerShell/curl把API数据存成本地JSON文件，再用JSON源读取，方便直接打开文件验证数据是否正确。

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