跳到主要内容

快速开始

欢迎使用 TS 数据筛选平台 开放 API。本文档面向需要通过 API 接入平台的开发者,覆盖签名认证、任务创建、状态查询与结果下载的完整流程。

接入流程概览

  1. 申请账号与 ApiKey(联系平台负责人)
  2. 签名规则生成 X-Api-Key
  3. 调用接口创建任务:
  4. 轮询「查询任务状态」接口,等待任务完成
  5. 调用「生成下载链接」接口获取结果文件
  6. 遵守限流规则上线

账号准备

参数名称类型必填描述
actString平台分配的用户账号(如:partner01)
ApiKeyString平台负责人提供

请求约定

  • 统一域名https://api.ts-filter.com/
  • 统一根路径/api/openapi
  • 请求头
X-Api-Account: <act>
X-Api-Key: <timestamp.signature>

X-Api-Key 的生成方式见签名算法

接口一览

接口方法路径说明
上传文件POST/api/openapi/upload上传号码文件,返回预估费用
创建筛选任务POST/api/openapi/addTask基于已上传文件创建任务
一键上传并创建任务POST/api/openapi/uploadAndCreateTask上传 + 创建一步完成(推荐)
查询任务状态GET/api/openapi/task/{taskId}轮询任务进度与状态
生成下载链接POST/api/openapi/download任务完成后获取结果文件
查询产品状态(单个)GET/api/openapi/taskType/status/{taskType}查询任务类型是否可下单
批量查询产品状态POST/api/openapi/taskType/statusBatch批量查询任务类型上架状态
查询用户余额GET/api/openapi/user/balance查询账户余额
建议

下单前先通过查询产品状态确认任务类型已上架,并通过查询余额确认余额充足。