伙伴云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 加解密
    • 订阅回调事件
    • 添加订阅
    • 取消订阅
    • 获取订阅列表
  • 服务商
    • 获取 access_token
    • 获取服务商的 api_key
    • 获取服务商信息
    • 设置订阅回调地址
    • 获取订阅回调地址
  • 数据模型
    • 通用模型
      • Space
        • 工作区
        • 封面
      • Table
        • Config
          • text 文本类型
          • date 日期类型
          • category 选项类型
          • user 用户类型
          • relation 关联类型
          • signature 签名类型
          • file 文件类型
          • location 位置类型
          • numeric 数字类型
        • 字段配置
        • 字段列表
        • 表格配置
        • 表格
        • 数据仓库表格配置
      • Item
        • Field
          • signature 签名
          • location 位置
          • file 文件
          • text 文本
          • numeric 数字
          • date 日期
          • category 选项
          • user 用户
          • relation 关联
        • 数据
        • 字段值
        • 字段提交
      • Filter
        • Query
          • Eqm
          • Eq
          • Ne
          • Gt
          • Gte
          • Lt
          • Lte
          • In
          • Ain
          • Nin
          • Inc
          • Em
        • Connector
          • And
          • Or
        • Filter
        • Query
        • Condition
        • Connector
      • Object
        • 用户
        • 备选项
        • 位置
        • 文件
        • 签名
      • Procedure
        • 流程
        • 流程实例
        • 流程执行记录
        • 流程任务
    • 业务模型
      • 订阅
      • 回调信息
      • 服务商信息
      • 企业信息
    • 异常报错
    • 全局返回
  1. 开发指南

更新日志

2022年5月30日#

支持事件订阅机制#

可通过订阅指定表格数据的增、删、改事件,实现表格数据变更后自动推送到指定的“接收推送 URL”,满足从伙伴云主动即时同步数据到企业内部系统或第三方的 SaaS 服务中的场景。
可在企业后台的接口授权中为需要的 API Key 配置回调地址,服务商可通过“设置订阅回调地址”接口进行设置。
如果您对消息内容的安全级别要求较高,可以通过与伙伴云约定密钥的方式,对订阅事件的数据 Encrypt Key 进行加密推送。

支持服务商接入机制#

第三方 SaaS 服务商可接入伙伴云,代企业调用授权接口,实现专业 SaaS 的业务数据与伙伴云进行互通,借助伙伴云的零代码灵活的数据处理与分析能力,为客户提供综合解决方案。可加企业微信,洽谈接入合作。
请在微信内访问:https://work.weixin.qq.com/u/vc7d5bd16ddf5c7a70?v=4.0.6.90001&src=wx

2022年5月13日#

调整接口地址的命名规范,请按照最新的接口命名来进行调用,旧版的接口地址将于2022年7月13日后不再支持。
接口旧版新版
获取工作区列表/openapi/v1/space/list/openapi/v1/space/list
获取工作区成员列表/openapi/v1/member/list/openapi/v1/member/list
获取表格列表/openapi/v1/table/list/openapi/v1/table/list
获取表格配置/openapi/v1/table/{table_id}/openapi/v1/table/{table_id}
查询数据列表/openapi/v1/item/list/openapi/v1/item/list
获取数据详情/openapi/v1/item/{item_id}/openapi/v1/item/{item_id}
创建数据/openapi/v1/item/openapi/v1/item
更新数据/openapi/v1/item/{item_id}/openapi/v1/item/{item_id}
删除数据/openapi/v1/item/{item_id}/openapi/v1/item/{item_id}
上传文件/openapi/v1/file/upload/openapi/v1/file/upload

2022年5月12日#

企业级「接口授权」全新上线#

为了给企业提供稳定、易用的数据接口能力,伙伴云在 5.0 新版中提供了企业级「接口授权」管理和全新的 OpenAPI 。可以满足与企业内部系统的数据双向互通,或与第三方 SaaS 产品对接的定制化数据需求。

OpenAPI 首度开放#

企业级 API 首批开放了基础的数据能力接口,后续会继续开放诸如通讯录、流程、数据仓库、触发器等接口,开发者可以借此,实现企业服务与伙伴云的集成。支持的能力按功能进行归类,如工作区、表格、数据等。
修改于 2022-05-30 12:47:11
上一页
数据筛选器
下一页
获取工作区列表
Built with