REST API 数据源配置指南

概述

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

参数配置

1. 数据源名称：为 REST API 数据源指定一个明确且唯一的名称，以便进行识别和管理。
2. URL 地址：输入 RESTful 服务的基础 URL，这是 API 服务的根地址，将用于所有数据同步操作。
3. 请求方式：选择数据同步任务中使用的 HTTP 请求方法，可以是GET或POST。
4. 默认请求头（可选）：添加任何必要的HTTP请求头信息，以 Key-Value 方式组织，如Content-Type，默认值为application/json。
5. 验证方法：选择 RESTful 服务所需的验证方式，以确保数据传输的安全性。
   • 不验证：如果 API 服务不需要验证，选择此项。
   • 基础验证（Basic Auth）：如果 API 服务支持使用用户名和密码进行验证，选择此项，并配置相应的用户名和密码。
   • Bearer Token 验证：如果 API 服务接受 Bearer Token 进行验证，选择此项，并提供有效的 Token 值。
6. 数据源描述（可选）：提供数据源的描述性信息，以帮助理解该数据源的用途和特点。

连接测试

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

注意事项

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

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