跳到主要内容

维格云 API 简介

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

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

你能用维格云 API 做什么​

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

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

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

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

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

开放接口​

目前维格云开放 7 种类型的 API 接口：记录、字段、视图、附件、空间站、工作目录、通讯录，详情请查看对应的接口文档。

常用参数​

维格表 API 请求的基本 URL 是 https://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 地址栏中找到以 dst、fod、fom 或者 dsb 开头的一段字符串，这便是这个文件的 nodeId 了。

datasheetId​

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

获取 datasheetId 的方式很简单：

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

URL 地址栏 - datasheetId

dashboardId​

每一张仪表盘都有对应的仪表盘 ID（即 dashboardId）。

获取 dashboardId 的方式很简单：

打开任意一张仪表盘，在 URL 地址栏中找到以 dsb 开头的一段字符串，这便是这张仪表盘的 dashboardId 了。

URL 地址栏 - dashboardId

formId​

每一张表单都有对应的表单 ID（即 formId）。

获取 formId 的方式很简单：

打开任意一张表单，在 URL 地址栏中找到以 fom 开头的一段字符串，这便是这张表单的 formId 了。

URL 地址栏 - formId

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。

unitId​

如果我们把一个空间站看作一家公司，那么小组就可以看作是公司内部的部门。 因此，您可以在空间站内创建多个小组，成员可以归属于多个小组。

一个空间站的通讯录由若干小组和成员组成（了解小组和成员）

  • 每个小组可以分配多个成员
  • 每个成员也可以属于多个小组

而角色不属于通讯录的组成部分，每个角色可以关联多个成员或小组。（了解角色）

对于每一个成员、小组、角色，都有对应唯一 ID，也就是 unitId。

你可以使用这个 unitId 去获取、更新、删除对应的成员、小组、角色，详细可见对应的 API 使用文档。