伙伴云OpenAPI
  1. 订阅
伙伴云OpenAPI
  • 开发指南
    • 开发前必读
    • 申请 API Key
    • 基本概念介绍
    • 数据筛选器
    • 更新日志
  • 工作区
    • 获取工作区列表
      GET
    • 获取工作区成员列表
      POST
  • 表格数据
    • 获取表格列表
      POST
    • 获取表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 创建数据
      POST
    • 更新数据
      PUT
    • 删除数据
      DELETE
    • 批量创建数据
      POST
    • 批量更新或创建数据
      PUT
    • 批量删除数据
      DELETE
  • 数据仓库数据
    • 获取数据仓库表格列表
      POST
    • 获取数据仓库表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 批量创建数据
      POST
    • 批量更新数据
      PUT
    • 根据数据ID列表更新成相同数据
      PUT
    • 批量删除数据
      DELETE
  • 文件
    • 批量获取文件详情
    • 上传文件
  • 订阅
    • 订阅事件概述
    • Encrypt Key 加解密
    • 订阅回调事件
    • 添加订阅
      POST
    • 取消订阅
      POST
    • 获取订阅列表
      POST
  • 服务商
    • 获取 access_token
    • 获取服务商的 api_key
    • 获取服务商信息
    • 设置订阅回调地址
    • 获取订阅回调地址
  1. 订阅

订阅事件概述

可通过订阅指定表格数据的增、删、改事件,实现表格数据变更后自动推送到指定的“接收推送 URL”,满足从伙伴云主动即时同步数据到企业内部系统或第三方的 SaaS 服务中的场景。
为了能够接收事件订阅消息,首先你必须在企业后台的接口授权中,为需要的 API Key 配置“接收推送 URL”(服务商需要通过“设置订阅回调地址”接口进行设置)。当订阅的事件触发时,伙伴云会通过 1.117.102.251 这个固定的 IP 地址向该网址发送相应的 HTTP POST 请求。

请求网址校验#

填写你要配置的接收推送 URL 后,点击保存按钮时,伙伴云会向你配置的网址推送一个 application/json 格式的 POST 请求,用于验证你配置网址的合法性。
是否配置 Encrypt Key,会收到不同的验证请求

未设置 Encrypt Key#

// 收到的请求
{ 
    "challenge": "hkL4836cYoR65Db6c6rl", // 需要原样返回的值 
    "type": "url_verification"      // 表示这是一个验证请求 
}
当收到伙伴云 POST 验证请求时,你需要解析出 challenge 值,并在 1s 内原样返回该 challenge 值作为响应。
// 你应该响应的内容如下
{ 
    "challenge": "hkL4836cYoR65Db6c6rl" // 需要原样返回的值 
} 

已设置Encrypt Key#

// 收到的请求
{
    "encrypted": "GHAXvJ7syzitkksiTBzUEuQlr1+R0pue6lKA75IDtiVrChrldlNEXc2TityGzg3y3QPSXYOVCGntnem/aHtML3+wgw58uoSOuUll7ljVZm4QkHkc9CZYjOgxtvvW2Fbz" // 加密字符串,解密方法请看“Encrypt Key 加解密”文档
} 
当你收到伙伴云 POST 验证请求时,需要解密出 encrypted 的内容(解密参考“Encrypt Key 加解密”文档中的示例代码),如下:
// 解密后的内容
{ 
    "challenge": "hkL4836cYoR65Db6c6rl", // 需要原样返回的值 
    "type": "url_verification"      // 表示这是一个验证请求 
}
从解密后的内容中解析出 challenge 值,并在 1s 内原样返回该 challenge 值作为响应。
//响应内容如下
{ 
    "challenge": "hkL4836cYoR65Db6c6rl" // 需要原样返回的值 
} 
修改于 2023-11-28 04:09:41
上一页
上传文件
下一页
Encrypt Key 加解密
Built with