概述
Rest API 数据源支持通过 HTTP / HTTPS 接口读取第三方系统开放的数据，适用于从业务系统的开放接口获取数据的场景。DataBuddy 数据接入支持将 Rest API 作为来源端，覆盖离线同步场景。本文介绍其连接配置、能力支持范围、前提条件与常见问题。
支持的版本
类型 | 支持版本 |
Rest API | 全版本（HTTP / HTTPS） |
读取能力
「读 / 写」与「离线 / 实时」是两个正交的维度：读、写表示数据流向（从该数据源读取 / 写入该数据源），离线、实时表示同步方式。下表各项能力的支持情况均按「读 / 写」的顺序给出。
能力 | 支持情况 | 说明 |
离线同步（读 / 写） | ✓ / ✗ | 支持作为离线同步任务的源端读取数据；DataBuddy 数据源仅支持接入读取，不支持写入 |
使用限制
限制项 | 说明 |
响应格式 | 需返回 JSON 格式数据 |
认证方式 | 支持无认证 / Basic / Token / OAuth2 密码模式 / OAuth2 客户端模式 |
支持的认证方式
认证方式 | 说明 |
无认证 | 接口无需认证 |
Basic | 用户名 + 密码 |
Token | 固定令牌 |
OAuth2 密码模式 | 用户名 + 密码换取令牌 |
OAuth2 客户端模式 | ClientId + ClientSecret 换取令牌 |
前提条件
向接口提供方确认接口地址、请求方式与认证信息，并确保接口可从 DataBuddy 运行环境访问。
接口响应需为 JSON 格式，且字段结构稳定。
创建数据源
操作步骤
1. 登录 DataBuddy 控制台。
2. 在顶部切换到目标地域和 Workspace。
3. 进入 数据接入 > 任务管理 > 数据源管理（或 平台管理 > 数据源管理）。
4. 点击 添加数据源，选择 Rest API。
5. 填写连接配置与认证信息，详见 参数说明。
6. 点击 测试连接（参见 数据源连通性测试）。
7. 测试通过后点击 保存 或 保存 & 创建任务。
参数说明
参数 | 说明 | 是否必填 | 默认值 |
数据源名称 | 数据源在工作空间内的唯一标识 | 是 | — |
请求地址 | 接口完整 URL | 是 | — |
认证方式 | 无认证 / Basic / Token / OAuth2 密码模式 / OAuth2 客户端模式 | 是 | 无认证 |
用户名 / 密码 | Basic 或 OAuth2 密码模式下的账号 | 相应认证方式必填 | — |
Token | Token 认证下的固定令牌 | 认证方式为 Token 时必填 | — |
ClientId / ClientSecret | OAuth2 客户端模式下的凭证 | 认证方式为 OAuth2 客户端模式时必填 | — |
Token 端点 / Scope | OAuth2 模式下的令牌端点与作用域 | OAuth2 认证时必填 | — |
在数据接入任务中使用
离线数据读取
配置项 | 说明 |
数据来源 | 已配置的 Rest API 数据源 |
请求参数 | 按接口定义填写请求参数，支持分页与时间参数 |
最佳实践
实践 | 建议 |
认证安全 | 优先使用 OAuth2，避免明文密码 |
分页处理 | 确认接口分页机制，避免数据遗漏 |
限流控制 | 合理设置请求频率，避免触发接口限流 |
常见问题
Q：认证失败？
A：检查认证方式与凭证是否正确，确认令牌未过期。
Q：数据不完整？
A：确认接口分页参数设置正确，且响应为稳定 JSON 结构。
