¶ 一、适用场景
当您需要把爬爬藤收集到的表单数据同步到自己的 CRM、ERP、Excel 或数据看板时,不必手工导出,直接调用开放接口按需拉取即可。接口返回标准 JSON,支持分页与时间范围筛选。
¶ 二、获取接口地址与 API 密钥
- PC 端登录后进入「我的内容」,找到要取数的内容,点击卡片上的「数据」按钮。
- 在弹出的「采集数据」窗口顶部找到「API接口」一行,点击展开。
- 展开后可看到「接口地址」与「API 密钥」,分别点击右侧「复制」即可取用。
💡 小贴士
密钥默认脱敏显示(pk_xxxx••••••••xxxx),点「显示」查看完整密钥。一个内容对应一把密钥,互不通用;首次打开时会自动生成。
⚠️ 注意事项
API 密钥等同于读取该内容采集数据的凭证,请勿写入前端代码、公开仓库或聊天群。若怀疑泄露,在面板中点「重置密钥」,旧密钥立即失效。
¶ 三、接口说明
- 请求方式:GET,无需登录态。
- 接口地址:https://www.papateng.cn/api/v1/form-collection/open/submissions(面板中已拼好 manualId)。
- 鉴权方式:推荐请求头携带 X-Api-Key,也可使用查询参数 key。
- 返回格式:JSON,含 total / page / size / list 四个字段。
¶ 四、请求参数
- manualId:必填,内容 ID,面板复制的地址已自带。
- page:选填,页码,默认 1。
- size:选填,每页条数,默认 20,上限 100。
- startTime / endTime:选填,提交时间范围,格式 yyyy-MM-dd,含当日。
¶ 五、调用示例
方式一:查询参数 key(最简单,展开面板后可直接复制「调用示例」执行)
curl "https://www.papateng.cn/api/v1/form-collection/open/submissions?manualId=793&key=pk_xxxxxxxx"方式二:请求头 X-Api-Key(推荐,密钥不会出现在 URL 与访问日志中)
curl -H "X-Api-Key: pk_xxxxxxxx" "https://www.papateng.cn/api/v1/form-collection/open/submissions?manualId=793&page=1&size=20&startTime=2026-10-01&endTime=2026-10-14"¶ 六、返回结果说明
data.list 中每一条为一次表单提交,字段含义如下:
- id:提交记录 ID。
- moduleId / formId:所属页面与表单 ID。
- submitterName:提交者名称,游客提交时为空。
- formData:表单字段键值对(键为表单字段名)。
- attachments:附件列表,含 fileName、size 与可直接下载的 url。
- submitTime:提交时间(yyyy-MM-dd HH:mm:ss)。
- clientIp:提交人 IP。
¶ 七、常见错误码
- 401 缺少API密钥:未携带 key 或 X-Api-Key。
- 403 API密钥无效或已停用:密钥有误、已被重置,或用本内容的密钥去取其它内容的数据。
- 400 缺少参数 manualId:地址里没有带 manualId。
- 500 数据查询失败:服务端异常,请稍后重试或联系我们。
⚠️ 注意事项
附件下载地址默认按当前站点域名生成。若服务部署在内网或经反向代理,可能返回内网地址导致无法下载,请联系我们配置站点根地址。
¶ 八、注意事项
- 接口只返回该密钥绑定内容的数据,无法跨内容读取。
- 重置密钥后旧密钥立即失效,需同步更新第三方系统配置。
- 接口不提供按提交人或关键字过滤,如需筛选请先在页面导出后自行处理。
- 请合理控制调用频率,避免高频轮询。
💡 小贴士
若展开面板后看不到密钥,请确认后台已执行最新的数据表变更(form_api_key 表)。
