快速上手

本文介绍如何在 5 分钟内快速上手体验维格云 API。

第一步：获取 API Token

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

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

获取 API Token 的方式如下：

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

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

3. 复制 API Token。

注意：

• 请妥善保管你的 API Token，如果 API Token 泄露，他人可能随意篡改你的表格中的数据。
• 如果 API Token 意外泄露，你可以在「开发者配置」界面重新生成 Token，保证数据安全。

第二步：调用 API 接口，实现数据的增删改查

选择你熟悉的编程语言（如 Javascript），确定你需要调用的维格云 API 接口后，你可以选择以下任一方式向 API 服务器发送请求。

方法一：直接发送 HTTPS 请求

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

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

cURL

curl "https://vika.cn/fusion/v1/datasheets/{datasheetId}/records" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {你的 API Token}"

JavaScript

// 方法一：Fetch
const URL = 'https://vika.cn/fusion/v1/datasheets/{datasheetId}/records'
const res = await fetch(URL, {
  method: 'GET',
  headers: new Headers({
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {你的 API Token}'
  })
})

//方法二：Axios
const URL = 'https://vika.cn/fusion/v1/datasheets/{datasheetId}/records'
const res = await axios.get(URL, {
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {你的 API Token}'
  }
});

Python

import requests

request_url = 'https://vika.cn/fusion/v1/datasheets/{datasheetId}/records'
headers = {"Authorization": "Bearer {你的 API Token}","Content-Type":"application/json"}
response = requests.get(request_url, headers=headers)
result = response.json()

你也可以选择其他任何语言或库来发送 HTTPS 请求。

方法二：使用官方提供的 SDK

SDK（Software Development Kit，软件开发工具包）提供了对网络请求和认证的封装，处理好了很多 API 请求上的细节问题，帮助你快速开始体验维格云 API。

维格云官方在 GitHub 上提供 Javascript SDK 和 Python SDK，能让你轻松使用 Javascript 和 Python 语言调用维格云 API，实现数据的增删改查。

使用 SDK 之前，需要先在电脑的终端上执行以下命令，进行 SDK 的安装和初始化：

Javascript SDK

1. 通过以下任一方式安装 Javascript SDK。

   npm

   # 需要提前安装 npm
   npm install @vikadata/vika@latest

   yarn

   # 需要提前安装 yarn
   yarn add @vikadata/vika@latest

2. 初始化 Javascript SDK。

   import { Vika } from "@vikadata/vika";
   const vika  = new Vika({ token: "_替换成你的_API_Token_"});

   在实例化 SDK 客户端时你可以选择配置如下全局参数：

   选项	类型	默认值	说明
   token	string		必填，代表传入的 API Token
   fieldKey	string	name	查询字段和返回字段时所用的 key。默认使用 name（字段名称）。\n指定为 id 时将以 fieldId 作为查询和返回方式（使用 id 可以避免因修改字段名称而导致的代码失效问题）
   requestTimeout	number	60000	请求失效时间，单位毫秒，默认值为 60000（即 10 秒）
   host	string	https://vika.cn/fusion/v1	目标服务器地址
   adapter	any		如果需要在微信小程序中使用，需要添加请求适配器，参见在微信小程序中使用 Vika JS SDK

Python SDK

1. 安装 Python SDK。

   # Python 版本需要是 v3.6 或以上
   # 需要提前安装 pip
   pip install --upgrade vika

2. 初始化 Python SDK。

   from vika import Vika
   vika = Vika("_替换成你的API_Token_")

确定好请求方式后，便可以编写代码，调用相应的维格云 API 接口了。