datai/docs/archive/api-docs/integration/DataiIntegrationRealtimeSyncController/0002-start-realtime-sync.md

1.1 KiB
Raw Blame History

启动实时同步服务接口

接口信息

  • 接口路径: /integration/realtime/start
  • 请求方法: POST
  • 功能描述: 启动实时同步服务开始订阅Salesforce Change Events
  • 权限要求: integration:realtime:start

请求参数

参数名 类型 位置 必选 描述
- - - 无请求参数

响应参数

参数名 类型 描述
success boolean 请求是否成功
message string 响应消息

响应示例

{
  "success": true,
  "message": "实时同步服务启动成功"
}

错误示例

{
  "success": false,
  "message": "实时同步服务启动失败: 无法获取Salesforce连接"
}

接口说明

  1. 该接口用于启动实时同步服务开始订阅Salesforce Change Events
  2. 启动过程中会刷新对象注册表,获取启用实时同步的对象列表
  3. 接口需要integration:realtime:start权限才能访问
  4. 如果没有权限或发生其他错误,接口会返回失败信息