02-数据接入API

数据接入（API）用于接入 SaaS、ERP、CRM、WMS、OA 等系统的 REST API 数据。平台通过连接器、授权凭证和同步任务三层结构管理 API 数据接入。

进入方式

在左侧导航栏选择 数据工厂 > 数据接入（API）。

页面功能

区域	说明
连接器目录	展示已注册连接器，例如 ERP、WMS、CRM 等系统连接器。
统计信息	展示连接器总数、授权数量、同步任务数量等概览信息。
搜索筛选	支持按连接器名称、分类筛选。
连接器卡片	展示连接器名称、内部标识、分类和能力入口。

连接器详情

点击连接器卡片可查看连接器详情。详情通常包含：

字段	说明
数据流名称	连接器可同步的数据对象，例如订单、客户、商品。
显示名	面向业务用户展示的名称。
描述	数据流的业务含义。
参数	同步时可配置的业务参数。
状态	该数据流是否可用。

授权管理

点击授权管理入口后，可维护 API 连接所需凭证。

常用操作：

1. 点击 新建授权。
2. 选择连接器并填写授权名称。
3. 按连接器要求填写密钥、账号密码、AppKey、AppSecret 等认证字段。
4. 如连接器支持 OAuth，点击 前往授权 完成第三方授权。
5. 点击 测试连接 验证凭证是否可用。

提示：OAuth 授权会打开独立授权窗口，授权完成后页面会自动接收授权结果。

新建同步任务

1. 在连接器卡片点击 新建同步任务。
2. 选择该连接器下可用授权。
3. 配置调度信息，例如手动执行或 Cron 表达式。
4. 确认创建后，系统生成 api_{id} 形式的同步任务标识。

同步任务工作台

进入同步任务工作台后，可按 stream 维度配置同步策略：

配置项	说明
启用状态	控制该数据流是否参与同步。
写入模式	控制 append、replace、merge 等写入方式。
分区粒度	按连接器建议配置数据落湖分区。
增量起始值	第一次增量同步的起点。
业务参数	由连接器 param_spec 动态生成，例如店铺、开始日期等。

执行同步

在同步任务工作台点击 执行，平台会触发对应 API 任务。任务状态可在 运行记录 中查看。

注意事项

• API 授权字段因连接器不同而不同，应以页面动态表单为准。

• 如果连接器提示需要管理员配置，应先到 连接器配置 完成全局配置。

• 增量同步前应确认接口是否支持游标、时间戳或分页。

• OAuth 凭证过期后，需要重新授权。