如何正确处理Wix API /members/v1/members接口的分页与排序？

我们通过Wix API获取网站成员列表时遇到问题：示例用R语言实现，但Python中也存在相同问题。调用下方函数时，每次返回成员数量均为9744，但每次返回的成员集合不同，无法获取完整的9744个唯一成员，总是存在重复和遗漏。例如：

members <- fetch_members()
which(members$login_email == 'myemail@gmail.com')
[1] 8165

members <- fetch_members()
which(members$login_email == 'myemail@gmail.com')
[1] 8165 9698

members <- fetch_members()
which(members$login_email == 'myemail@gmail.com')
integer(0)

当前使用的R代码实现：

headers = c(
  `Authorization` = access_key,
  `wix-site-id` = our_site_id
)

fetch_members <- function() {

  # set constants
  # endpoint <- "https://www.wixapis.com/members/v1/members"

  offset <- 0
  limit <- 1000
  is_paging <- TRUE
  output_list <- c()
  params <- list(`paging.limit` = limit, fieldSet = 'FULL', sort = c('createdDate'))
  
  # page through the api, fetching data 
  while(is_paging) {
    print(paste0('offset: ', offset))
    
    # set params, make fetch
    params$`paging.offset` <- offset
    res <- httr::GET(url = endpoint, httr::add_headers(.headers=headers), query = params)
    res
    
    # grab members, metadata from fetch
    content <- httr::content(res)
    metadata <- content$metadata
    this_list <- content$members
    length(this_list)
    
    # add to list, increment offset, and assess paging
    output_list <- c(output_list, this_list)
    offset <- offset + limit
    is_paging <- metadata$count == limit
  }
  
  # flatten the data
  members_df <- output_list %>%
    purrr::map(unlist) %>%
    purrr::map(t) %>%
    purrr::map(as_tibble, .name_repair = ~make.names(., unique = TRUE)) %>%
    dplyr::bind_rows() %>%
    readr::type_convert() %>%
    janitor::clean_names(case = 'snake')
  
  # and return
  return(members_df)
}

我们参考了官方文档，认为分页逻辑无问题（metadata中offset和limit显示正常），问题可能出在排序上。请问如何正确实现该接口的排序？

补充说明：我们也尝试过/members/v1/members/query接口，但该接口的分页与排序也无法正常工作。即使将分页limit设为100，只要能解决问题，我们也愿意使用该接口。

解决方案 #

核心问题：排序字段不唯一导致分页偏移失效 #

Wix API的分页依赖稳定的排序规则，如果排序字段存在大量重复值（比如多个成员的createdDate完全相同），API返回的结果顺序会在分页请求时发生随机变化，导致偏移量offset无法准确定位，最终出现重复或遗漏。

修复方案：使用唯一排序键 #

需要确保排序字段组合能唯一标识每条记录，避免顺序随机波动。推荐两种方式：

1. 组合排序字段：将createdDate与唯一ID字段（如id）组合排序，确保即使创建时间相同，也能通过ID保持稳定顺序。
   修改请求参数中的sort参数：

   # R语言示例：按createdDate升序，再按id升序
   params <- list(`paging.limit` = limit, fieldSet = 'FULL', sort = c('createdDate', 'id'))
   

   若需降序，可在字段名前加-：

   params <- list(`paging.limit` = limit, fieldSet = 'FULL', sort = c('-createdDate', '-id'))
   

2. 直接使用唯一ID排序：如果不需要按创建时间排序，直接用成员的id作为排序字段，这是最稳定的方式：

   params <- list(`paging.limit` = limit, fieldSet = 'FULL', sort = c('id'))
   

额外优化建议 #

• 去重处理：在最终合并数据时添加去重步骤，避免API偶发重复返回导致的冗余：

  members_df <- output_list %>%
    purrr::map(unlist) %>%
    purrr::map(t) %>%
    purrr::map(as_tibble, .name_repair = ~make.names(., unique = TRUE)) %>%
    dplyr::bind_rows() %>%
    dplyr::distinct(id, .keep_all = TRUE) %>% # 按id去重
    readr::type_convert() %>%
    janitor::clean_names(case = 'snake')
  

• Query接口的正确用法：若改用query接口，需在请求体中指定稳定排序规则，R语言示例：

  query_body <- list(
    sort = list(list(fieldName = "createdDate", order = "ASC"), list(fieldName = "id", order = "ASC")),
    paging = list(limit = limit, offset = offset),
    fieldsets = list("FULL")
  )
  
  res <- httr::POST(
    url = "https://www.wixapis.com/members/v1/members/query",
    httr::add_headers(.headers=headers),
    body = query_body,
    encode = "json"
  )
  

验证方法 #

修改排序参数后，多次调用fetch_members()函数，检查同一成员的位置是否固定，且最终数据集中无重复、无遗漏，总唯一成员数等于实际总数。

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