批量读取 API - 概述
批量读取API允许您获取大量数据。当您需要导出大量数据或对数据进行备份而不影响API限制时,这个API非常有用。
这是一个异步API,意味着您的请求响应不是立即可用的。当数据准备好下载时,您将收到回调URL的通知,或者您可以选择定期检查任务状态。
备注:
结果只能作为可下载的CSV文件提供。如何操作
第一步:创建批量读取任务
通过提供模块、要导出的字段列表和筛选记录的标准,创建(或生成)POST API调用。它将创建一个异步任务并返回一个惟一标识符param 'id',它是您的请求的引用
第二步:检查任务状态
如果您需要系统在任务完成时自动通知您,您可以在创建批量读取任务时简单地提供“回调”URL。此外,您还可以选择通过使用任务的“id”进行GET API调用来定期检查任务的状态。
第三步:下载结果
当任务成功完成时,“download_url”在API响应的“result”属性中可用。现在,您可以通过调用download_url下载任务的结果。将下载一个ZIP文件,其中包含CSV文件。