Apifox × 维格表使用指南
Apifox 是接口管理、开发、测试全流程集成工具。而通过 Apifox 这一工具调试维格表大家不再需要复制粘贴 API 地址,记各种请求参数是什么意义,只需要找到想要调试的 API 按需设置参数即可实现快速调试。
快速上手
在左侧的目录区域中,包含维格表所有的 API 分类,选择对应的分类即可查看该分类下的 API 接口。
点击后对应的 API 接口后,右侧就会展示出接口的详细信息和运行按钮,点击运行按钮即可快速开始调试。
此时需要注意得是调用 API 接口均需要配置 API Token,API Token 即用户认证令牌。向维格表服务器发送 API 请求时,必须在请求头里带上 Authorization: Bearer {你的 API Token},方便服务器认证用户身份,否则将会提示身份认证失败。
{
"success": false,
"code": 401,
"message": "身份认证失败"
}
而在 Apifox 中设置 API Token 也非常简单,只需要点击运行打开运行面板,在 Headers 中设置即可。
同时,由于部分 API 的请求路径中含有变量,例如:https://api.vika.cn/fusion/v1/datasheets/{datasheetId}/records
中的 {datasheetId}
代表想要操作的维格表 ID,因此在实际调试过程中建议大家在 Path 参数中修改为对应的参数。参数具体怎么获得请参考下面的常用参数章节。
如果查看接口的更多详细信息或进行更加详尽的调试,可以点击 Run in Apifox 或直接进入项目详情。
更详细的 Apifox 教学大家可以参考官方文档。
常用参数
维格表 API 请求的基本 URL 是 https://api.vika.cn/fusion/v1/
。
注意:必须使用 https 请求,不能使用 http 请求。
下面列举了调用接口时的一些常用参数,以及如何获取对应参数的值。
spaceId
单个用户可能创建或受邀进入多个空间站,每个空间站都有对应的空间站 ID(即 spaceId)。
你可以通过以下任一方式获取 spaceId:
1.登录维格表,点击左下角的个人头像,复制空间站 ID。
2.登录维格表,进入空间站驾驶舱,复制空间站 ID。
3.调用 获取空间站列表 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 了。
viewId
一张维格表中可能会创建多个视图。每个视图都有对应的视图 ID(即 viewId)。
获取 viewId 的方式很简单:
打开任意一张维格表,在 URL 地址栏中找到以 viw
开头的一段字符串,这便是这张维格表的 viewId 了。
recordId
一张维格表由若干行记录组成,每一行记录都有对应的记录 ID(即 recordId)。
你可以通过以下任一方式获取 recordId:
1.打开任意一张维格表,展开想要获取 recordId 的一行记录,在 URL 地址栏中找到以「rec」开头的一段字符串,这便是这行记录的 recordId 了。
2.你可以调用 获取记录 API 接口,来获取需要的 recordId。
fieldId
一张维格表由若干列组成,每一列对应着一个字段。每一个字段都有对应的字段 ID(即 fieldId)。
你可以通过以下任一方式获取 fieldId:
1.打开任意一张维格表,确认当前视图包含想要获取 fieldId 的字段,然后点击右上角的「API」打开 API 示例面板,在「Fields 字段」下面可以找到当前视图的所有字段信息,其中包括 fieldId。
2.你可以调用 获取字段 API 接口,来获取需要的 fieldId。