REST API 数据源配置指南

概述

REST API 是一种广泛使用的网络架构风格，它使得客户端可以通过 HTTP 协议与服务器进行交互。配置 REST API 数据源允许用户从 RESTful 服务中导入或导出数据，实现数据的同步和集成。

参数配置

配置 REST API 数据源时，需要提供以下信息：

• 数据源名称：为 REST API 数据源指定一个明确且唯一的名称，便于识别和管理。

• URL 地址：输入 RESTful 服务的基础 URL，用于数据同步操作。

• 请求方式：选择 HTTP 请求方法，支持

  GET

  GET
  或

  POST

  POST
  。

• 默认请求头（可选）：以 Key-Value 方式添加 HTTP 请求头。默认已填入

  Content-Type: application/json

  Content-Type: application/json
  。

• 验证方法：选择 API 服务所需的验证方式——不验证、基础认证（需配用户名密码）或 Bearer Token（需提供 Token）。

• 数据源描述（可选）：为数据源添加描述性信息，以帮助你或其他管理员理解该数据源的用途或特点。

• 可用工作空间：设置该数据源授权给哪些工作空间使用。可以指定工作空间，也可以授权给全部工作空间。

连接测试

• 测试连通性：在保存配置之前，可以点击“测试连通性”按钮，验证 API 服务地址的正确性和可访问性。此步骤仅检查 URL 地址的可达性，不进行身份认证（鉴权）。

注意事项

• 确保所有提供的连接信息准确无误，且 RESTful 服务是可访问的。
• 根据 RESTful 服务的要求配置请求头和认证方法，以确保数据传输的安全与有效。
• 保护你的认证信息，避免泄露给未经授权的人员。
• 遵守 RESTful 服务的 API 使用条款，合理控制请求频率，避免滥用。

完成上述配置后，你可以选择此 REST API 数据源进行数据同步任务的开发。配置 REST API 数据源时，应参考相关 RESTful 服务的 API 文档和支持资源，以获取最准确的指导。正确配置认证方法对于保护数据安全和确保数据同步的顺利进行至关重要。

相关文档

• 数据源支持范围
• 数据源管理
• 数据集成