电商连接器
概述
电商连接器是观远数据提供的电商平台数据对接服务,支持聚水潭、唯品会、抖音等主流电商平台的 API 数据获取。通过标准化 API 配置与定时任务调度,帮助用户将分散在电商平台的数据自动同步至指定数据库,供 BI 平台直接接入分析。
适用场景
在以下业务场景中,电商连接器能够显著降低数据接入与运维成本:
- 全渠道电商数据整合:业务涉及国内电商、跨境电商、ERP、广告投放等多种类型平台时,订单、商品、库存、广告消耗等数据分散在各平台后台,人工下载与拼接效率低且易出错。电商连接器支持对接 60+ 主流平台官方 API,将多源数据统一同步至指定数据库,消除数据孤岛。
- 自动化数据同步:传统模式下,每新增一个平台都需要经历资质申请、接口梳理、开发调试等流程,周期长、投入大。通过电商连接器的可视化配置与定时任务,可实现一次接入、长期自动更新,无需持续投入开发人力。
- 集中监控与运维:平台 API 频繁变更、任务异常难以及时发现、问题出现后难以定位根因。电商连接器提供任务状态监控、异常告警与日志追踪能力,帮助运维团队快速发现并定位问题,保障数据链路长期稳定运行。
前提条件
- 已从电商连接器平台管理员(以下简称「AC 管理员」)处获取平台登录账号(客户编号、用户名、密码)。
- 已在观远 BI 中获取 BI 平台的公网 IP(用于 AC 平台数据库白名单配置)。若 BI 环境由观远运维团队部署,可直接联系运维团队获取。
- 已完成电商平台的数据接入申报,平台列表由 AC 管理员维护。
快速入门
配置并使用电商连接器,整体可分为以下 5 个步骤:
- 登录平台:使用 AC 管理员提供的账号登录电商连接器平台。
- 配置数据库:选择 AC 管理员创建的数据库(设为默认),或自行新增 MySQL / PostgreSQL 数据库。
- 添加数据账户:在「数据账户管理」中选择电商平台并完成授权,绑定已配置的数据库。
- 运行与定时:手动运行 API 测试取数,确认无误后配置定时任务实现自动同步。
- BI 接入:在观远 BI 中创建数据账户,连接电商连接器数据库,即可开始分析。
操作步骤
登录电商连接器平台
-
打开浏览器,访问电商连接器平台登录页面(地址请联系 AC 管理员获取)。
-
输入客户编号、用户名和密码。输入完成后点击「登录」按钮。登录成功后进入平台首页。

配置数据库
首次使用电商连接器时,需要配置用于存储 API 运行结果的数据库。
- AC 管理员创建的数据库:无需自行添加,直接在「数据库管理」页面展示。首次登录平台时,建议设置一个默认数据库,点击数据库卡片中的「设为默认」按钮即可。
- 客户自建数据库:若需使用自有数据库,点击「新增数据库」按钮,目前支持 MySQL 和 PostgreSQL。

点击「新增数据库」按钮后,在弹窗中填写以下配置项:

| 配置项 | 是否必填 | 说明 |
|---|---|---|
| 数据库名称 | 是 | 在电商连接器平台中展示的数据库标识名称,便于后续识别。 |
| 数据库类型 | 是 | 选择数据库类型,目前支持 MySQL 和 PostgreSQL。 |
| 主机地址 | 是 | 数据库服务器的网络地址,填写域名或 IP 地址。 |
| 端口 | 是 | 数据库服务监听的网络端口号。MySQL 默认端口为 3306,PostgreSQL 默认端口为 5432。 |
| 数据库名 | 是 | 需要连接的具体数据库名称。 |
| 用户名 | 是 | 数据库的登录用户名,用于验证连接身份。 |
| 密码 | 是 | 与用户名配套的登录密码。 |
| 描述 | 否 | 数据库的备注说明,可选填。 |
填写完成后,点击「测试连接」验证网络与认证信息是否正确。测试通过后,点击「确定」保存配置。保存成功后,新增的数据库将在「数据库管理」页面展示。
配置数据账户
数据账户用于授权电商连接器访问指定的电商平台 API。
-
登录电商连接器平台,进入「数据账户管理」页面。
-
点击「新增数据账户」按钮,在弹出的平台列表中选择需要授权的平台(如「聚水潭(非淘系)」)。平台列表为客户已申报的平台,如有缺失请联系 AC 管理员确认。

-
根据页面提示完成平台授权。不同平台的授权方式不同,如有疑问请联系 AC 管理员获取帮助。授权成功后,该平台会在「数据账户管理」页面展示。

-
点击平台名称进入 API 管理页面。

-
在「概览 > 数据库」中配置对应的数据库。后续 API 的运行和定时任务的执行结果将写入该数据库。

-
点击「API 列表」,可以查看已经接入的所有 API,如果需要更多电商平台的 API,请联系 AC 管理员进行添加。

运行 API
-
在 API 管理页面,点击「API 列表」标签页,选择需要运行的 API。
-
点击「接口信息」标签页,然后点击「运行」按钮,弹出「运行 API」窗口。

-
在窗口中配置以下内容:

- 自定义参数:并非所有 API 都需要配置。时间参数可使用时间宏配置(详见时间宏配置)。
- 其他配置 > 切分单位:当自定义参数中包含特定时间参数(如 startTime 和 endTime)时出现,表示对该时间参数进行时间范围拆分。数据量较大时建议配置。
- 动态切分:开启后「取数时间预览」收起,程序自动动态切分数据。正常情况下无需开启。
- 是否覆盖:谨慎开启。开启后运行 API 时会先清空目标表中已有数据。
-
配置完成后点击「运行」按钮。运行成功后,数据将写入已配置的数据库。
查看运行日志
- 进入「运行记录」标签页。
- 找到目标运行记录,点击「查看日志」图标即可查看详细日志。

配置定时任务
-
在 API 管理页面,点击「API 列表」标签页,选择需要配置定时任务的 API。
-
点击「定时任务」标签页,然后点击「新增定时任务」按钮,弹出定时任务配置窗口。

-
配置任务名称和周期类型(必填)。若周期类型选择「每天」,还可以配置「时间」栏目,定时任务将在每天的该时间开始执行。

-
在「参数」栏目中配置时间参数。若未手动配置,系统会根据周期类型自动设值,具体可在「取数时间预览」栏目中预览。
说明若周期类型为「每天」且参数为开始时间与结束时间等时间段参数,当「取数时间预览」已展示下次执行的具体参数时,开始时间和结束时间参数可以不填,系统会自动设置。
-
配置完成后点击「保存」。保存成功后定时任务进入调度状态,按配置的周期自动执行。
关闭或删除定时任务
-
删除:在「定时任务」标签页中,点击目标任务操作列的「删除」图标即可删除。

-
停止:点击目标任务操作列的「编辑」图标,在弹窗中将「调度状态」开关关闭后保存。


任务重跑
当 API 运行或定时任务执行失败时,可通过任务重跑功能重新执行,避免重复填写参数。
-
进入「运行记录」标签页,找到运行失败的任务记录。
-
点击「重跑」按钮,系统将以原参数重新执行该任务。


复制 API
部分 API 支持复制功能,客户可基于已有 API 自定义接口配置。
- 在「API 列表」标签页中,找到带有「复制」按钮的 API。
- 点击「复制」按钮,根据页面提示自定义接口配置后保存。保存成功后生成新的 API 配置。

查询 API
部分接口(如订单类接口)支持查询功能,可使用具体订单号作为参数查询数据,查询结果不会写入数据库,仅供查看。
-
在「API 列表」标签页中,选择支持查询的 API,进入「接口信息」标签页。
-
点击「查询」按钮,弹出查询窗口。

-
在查询窗口中,将模板查询体中的占位符替换为具体订单号,点击「查询」按钮即可查看结果。

BI 连接电商连接器数据库
API 数据同步至电商连接器数据库后,需要在 BI 平台中创建数据账户以接入该数据库。
配置数据库白名单
若在 BI 中连接 AC 数据库时遇到「当前端口无法访问」等报错,需要开通 AC 平台对 BI 的 IP 白名单。

- 联系 AC 管理员,提供 BI 平台的公网 IP。
- AC 管理员在平台侧添加白名单后,再次在 BI 中测试连接。
若客户 BI 环境由观远运维团队部署,可直接联系观远运维团队获取 BI 平台的公网 IP。
在 BI 中创建数据账户
详细操作可参考数据账户。
注意事项
- 「是否覆盖」开关需谨慎开启,开启后运行 API 会先清空目标表中已有数据。
- 部分平台 API 较为复杂,如需复制或自定义接口配置,建议联系 AC 管理员协助。
- 自建数据库需确保网络可达,并在 AC 平台完成白名单配置。
- 定时任务的时间参数若已配置具体值,则以手动配置为准;未配置时系统按周期类型自动计算。
- today 时间宏代表当天 0 点,常用于配置「同步昨天 0 点到今天 0 点」的数据场景。