Skip to main content

维格表 API 简介

API(Application Programming Interface,应用程序接口)是一种通讯接口,为了在软件之间来回传递数据而诞生。

维格表官方提供各种 API 接口,可以让用户以 HTTPS 请求的方式从维格表上获取数据,或推送数据到维格表。

你能用维格表 API 做什么#

将维格表与其他软件连接,实现相互的数据传输,搭建高效工作流#

  • 连接钉钉机器人:实现当维格表有数据变动时,提醒到钉钉群组
  • 连接 iOS App “快捷指令”:实现从手机上快速写入一行记录到维格表
  • 连接浏览器插件:实现批量上传 Excel 里的图片到维格表
  • ……

作为后端的数据库,帮助快速搭建产品原型,验证想法#

维格表能轻松存储 10 万行以下量级的数据,你可以将其看作是一个轻量级的 NoSQL 数据库,无需一行 SQL 命令,轻松利用维格表 API 读取和写入数据。

  • 开发一款塞尔达菜谱小程序,轻松从维格表中读取菜谱数据
  • 开发一个轻量的课程论坛网站,轻松从维格表中读取讨论数据
  • 开发一款简易的笔记 App,轻松存储笔记数据到维格表
  • ……

开放接口#

目前维格表开放 6 种类型的 API 接口:记录、字段、视图、附件、空间站、工作目录。

记录#

接口类型接口作用
获取记录获取指定维格表中的记录
创建记录在指定维格表中创建一行或多行记录
更新记录在指定维格表中更新一行或多行记录
删除记录在指定维格表中删除一行或多行记录

字段#

接口类型接口作用
获取字段获取指定维格表中有权限查看的所有字段信息

视图#

接口类型接口作用
获取视图获取指定维格表中的所有视图

附件#

接口类型接口作用
上传附件上传附件到指定维格表中

空间站#

接口类型接口作用
获取空间站列表获取当前用户创建或受邀进入的所有空间站

工作目录#

接口类型接口作用
获取文件列表获取工作目录下最外层的文件列表
获取文件详情获取工作目录下指定文件的详细信息,文件类型包括维格表、文件夹、收集表、仪表盘

常用参数#

维格表 API 请求的基本 URL 是 https://api.vika.cn/fusion/v1/

注意:必须使用 https 请求,不能使用 http 请求。

下面列举了调用接口时的一些常用参数,以及如何获取对应参数的值。

spaceId#

单个用户可能创建或受邀进入多个空间站,每个空间站都有对应的空间站 ID(即 spaceId)。

你可以通过以下任一方式获取 spaceId:

1. 登录维格表,点击左下角的个人头像,粘贴空间站 ID。

个人头像 - 粘贴 spaceId

2. 登录维格表,进入空间站驾驶舱,粘贴空间站 ID。

空间站驾驶舱 - 粘贴 spaceId

  1. 调用 获取空间站列表 API 接口,来获取需要的 spaceId。

nodeId#

每个空间站下都有一个工作目录,这个工作目录下有很多文件节点 (node)。

每一个节点都有对应的 ID(即 nodeId)。文件节点的类型包括:

  • 维格表:其 nodeId 等同于 datasheetId,是以 dst 开头的一段字符串,如 dstZsEg3RpBvsdCgop
  • 文件夹:其 nodeId 是以 fod 开头的一段字符串,如 fod23ha5NvyM5
  • 收集表:其 nodeId 是以 fom 开头的一段字符串,如 fom680eghkCem0wZxk
  • 仪表盘:其 nodeId 是以 dsb 开头的一段字符串,如 dsbWxTei5gdTvdAfKM

获取 nodeId 的方式很简单:

打开任意一个文件节点(维格表、文件夹、收集表或者仪表盘),在 URL 地址栏中找到以 dstfodfom 或者 dsb 开头的一段字符串,这便是这个文件的 nodeId 了。

datasheetId#

每一张维格表都有对应的维格表 ID(即 datasheetId)。在调用 API 进行维格表数据的增删改查时,必须指定一个 datasheetId。

获取 datasheetId 的方式很简单:

打开任意一张维格表,在 URL 地址栏中找到以 dst 开头的一段字符串,这便是这张维格表的 datasheetId 了。

URL 地址栏 - datasheetId

viewId#

一张维格表中可能会创建多个视图。每个视图都有对应的视图 ID(即 viewId)。

获取 viewId 的方式很简单:

打开任意一张维格表,在 URL 地址栏中找到以 viw 开头的一段字符串,这便是这张维格表的 viewId 了。

URL 地址栏 - viewId

recordId#

一张维格表由若干行记录组成,每一行记录都有对应的记录 ID(即 recordId)。

你可以通过以下任一方式获取 recordId:

1. 打开任意一张维格表,展开想要获取 recordId 的一行记录,在 URL 地址栏中找到以「rec」开头的一段字符串,这便是这行记录的 recordId 了。

获取 recordId

  1. 你可以调用 获取记录 API 接口,来获取需要的 recordId。

fieldId#

一张维格表由若干列组成,每一列对应着一个字段。每一个字段都有对应的字段 ID(即 fieldId)。

你可以通过以下任一方式获取 fieldId:

1. 打开任意一张维格表,确认当前视图包含想要获取 fieldId 的字段,然后点击右上角的「API」打开 API 示例面板,在「Fields 字段」下面可以找到当前视图的所有字段信息,其中包括 fieldId。

获取 fieldId

  1. 你可以调用 获取字段 API 接口,来获取需要的 fieldId。