API(应用程序接口)是为了在软件之间来回传递数据而诞生的通讯接口。维格表官方的 API ,可以让用户以 http 请求的方式在互联网上进行维格表数据的拉取和推送,实现与各种 APP 或第三方平台的数据来回传输,搭建各种效率工作流,小程序,办公系统,网站...

你日常使用的各种手机 APP ,都是通过 API 与互联网连接,让数据流动起来。例如,你喜欢的社交平台,每天打开都会刷新最新的帖子;发布新帖后,好友们也能第一时间知道。这背后都是 API 在默默工作,当你打开 APP , APP 会向服务器提交一个 API 请求以拉取最新的帖子列表;当你将有趣的事情发布成帖子,APP 又会向服务器提交一个 API 请求以推送给其他好友。

已开放的API列表

维格表 API 具有与界面操作表格相同的权限控制,通过用户自身的 Token ,即可对指定表格进行操作。目前维格表已经发布下列 6 个记录( Record )级别与 1 个表( Datasheet )级别的 API 接口:

  • 获取记录( Get Records )
  • 新增记录( Add Records )
  • 更新记录( Update Records )
  • 删除记录( Delete Records )
  • 上传附件( Upload Attachment )

你需要掌握的基本概念

下面将要讲解的是使用 API 过程中可能会涉及的知识点,如果你有编程的基础经验,相信会更容易理解。(部分词汇可能跟维格表用户界面显示的有所出入,此文会略偏技术...)

API Token

API Token 是进行 API 调用时所需的用户认证令牌。举个例子:员工回公司上班时需要出示员工证,门卫才会放行,员工才能正常进入公司大楼。 同理,如果你想通过 API 访问某张维格表的数据,那么你需要有一个「令牌」,这个就是 API Token。


如何获取“我”的 API Token ?

访问维格表的工作台,然后点击左下角的个人头像,进入 「用户中心 > 开发者配置」 。首次使用需要绑定邮箱,然后点击生成 Token ,如下图:

生成Token


如果 API Token 意外泄露了,可以重新生成 Token :

重新生成Token

记录( Records )

先来看一个例子。假设动物园里有一个熊猫园区,动物管理员每月要统计一次所有熊猫的身体情况,那么他会如何统计呢?我猜,可能是这样的:

什么是记录

如上图所示,一条记录在维格视图里会以 「行」 的形式展示,在相册视图里以 「卡片」 的形式展示。但不管哪种展示形式,一条记录包含的是描述事物的一组完整信息。例如例子中的 “记录 1” ,描述了熊猫安安在 2020年09月15日 登记的体重为 80 公斤,体长为 1.2 米,肩高 65 厘米,登记人员是布小小...

在维格表中,记录( record )是最小的完整数据单位,若干条记录组成了一个维格表。在同一个维格表中,每一条记录有唯一的ID( recordId ),以 rec 开头的字符串。


字段( Fields )

如果说一条记录包含的是描述事物的完整信息,那么一个字段就是信息中的一个要素,例如例子中的 “昵称” , “体重” , “体长” , “肩高” 。在同一个维格表中,每个字段都有唯一的 ID( fieldId ),以 fld 开头的字符串。


表( Datasheets )

一个维格表由若干条记录组成,每一个表都有唯一 ID( datasheetId ),以 dst 开头的字符串。


视图( Views )

视图是一种数据呈现模式。 将维格表里的数据,以不同的筛选条件、不同的显示样式渲染到画面上。在同一个维格表中,每一个视图都有唯一的ID( viewId ),以 viw 开头的字符串。


从哪里可以获取到上述 IDs ?

① 通过浏览器地址栏获取

浏览器地址获取Ids


② 通过 API 面板获取

通过API面板获取


API 示例面板介绍

为了让维格用户可以更容易地学习和使用 API ,我们打造了 「API示例面板」 ,点击维格表(维格视图)的编辑区域右上角的 「API」 按钮或者快捷键 Ctrl + Shift + P , Mac: + + P 。左边是表格内容,右边是对应的 API 接口与说明,两者对照,是不是很直观?

API面板


① 显示 API Token

打开此选项,在示例里直接显示你的真实 API Token 。 默认情况下, API Token 是不会直接显示在示例中。

显示用户的Token


② 使用 FieldId

打开此选项,在示例里使用 fieldId 作为字段的 key 。 通过 API 进行数据传输时, JSON 格式是指定格式。字段会以 key:value 展示,例如下图的 "昵称": "安安""fldnb8v8NrHYv": "安安"

(1)通过字段的名称作为 key ,会更直观更语义化。但容易因字段名称变化而导致 API 调用失败。

(2)通过字段的 ID 作为 key ,则调用 API 的代码片段稳定性更好,因为无需关注字段的名称变化。

显示fieldIds


③ API 示例面板的 「Field 字段」 标签页

自动读取当前维格表的数据,然后将所有字段的基础信息以列表形式显示出来。在此标签页下,你可以清晰地了解字段的维格列类型、数据结构、描述、还附有一个 “实时、真实” 的示例值,学习 API 也可以变得通俗易懂:)

标签页-Field 字段


④ 示例值

根据列类型, API 示例面板会给出符合的示例值。此值会优先从当前表中自动读取,代入感满满。

示例值


通过 API 示例面板快速调试

在 Linux 或 Mac 平台的终端,通过 curl 指令快速体验维格表 API 的魅力。

API示例面板与cURL的使用

results matching ""

    No results matching ""