API接口对接文档


1.名词解析

名称

描述

工作目录

【指代】这只是一个抽象概念，并不具有任何功能，代表的是在工作台中的所有文件、文件夹的集合。在界面上显示的一个标识，方便人与人之间的表达沟通。

工作目录本质上是一个parent_id=0的文件夹

节点

【指代】如果把「工作目录」比喻为一颗参天大树，则「节点」就是大树上的树干分枝。

一个文件就是一个节点，一个文件夹也是一个节点

比如：文件夹、表格、神奇表单、镜像、仪表盘



2. API 接口清单

API类型

模块

接口

接口地址

接口说明

开放API

开放平台

维格表、视图、字段、记录、空间站、工作目录等开放API接口

Vika API接口开发手册

Vika API接口在线调试





3. 接入指南

3.1 API接口调用凭证

3.1.1 什么是API Token？

API Token 即用户认证令牌。向维格表服务器发送 API 请求时，必须在请求头里带：Authorization: Bearer {你的 API Token}，方便服务器认证用户身份。

认证成功后，这份 API 请求会拥有该用户在维格表界面操作时相同的权限，即用户能够在界面上操作什么数据，这份请求也能操作什么数据。


3.1.2 如何获取API Token？

获取 API Token 的方式如下：

  1. 登录维格表，点击左下角的个人头像，进入「用户中心」，前往「开发者配置」界面。

  1. 点击「+」号生成 API Token。注意：首次生成时需要绑定邮箱。

  1. 复制 API Token。

注意：

  • 请妥善保管你的 API Token，如果 API Token 泄露，他人可能随意篡改你的表格中的数据。

  • 如果 API Token 意外泄露，你可以在「开发者配置」界面重新生成 Token，保证数据安全。


3.1.3 如何使用API Token？

以调用「获取记录」API 接口为例，下面是一些常见语言的 HTTPS 请求示例：

注意：在执行下列代码前，你需要将 {datasheetId}和 {你的 API Token} 替换为真实的维格表 ID 和 API Token。

curl "https://api.vika.cn/fusion/v1/datasheets/{datasheetId}/records" \

 -H "Content-Type: application/json" \

 -H "Authorization: Bearer {你的 API Token}"