如何使用表格 API

目的

设置和使用 Tulip API，以便从其他系统与 Tulip 交互。

注：高级文章。

假定以前有过使用 API 的经验。

:::(Info) (注）高级文章：假定以前有过使用 API 的经验：::：

Tulip 通过连接器与许多其他系统的 API 进行交互。使用连接器Tulip 应用程序可以启动 HTTP 或 SQL 查询。

在其他情况下，您可能希望允许外部系统查询仅存在于 Tulip 中的数据。可以使用 Tulip API 从外部系统与 Tulip 通信。本文将介绍如何设置和测试 Tulip API。

Tulip API 在许多方面都有助于将这些外部系统与 Tulip 集成。API 目前仅适用于 Tulip表，包括用新信息更新表记录、创建表格或获取表中的记录数。

添加 API

导航到 Tulip 账户的 "设置 "页面。

在 "设置 "菜单中选择 "API 标记"。

该页面允许你配置 "API 标记"，即配备 API 密钥、秘密和授权头的 API 配置。要添加 API 令牌，请选择页面右上方的添加 API 令牌按钮。选择后，根据需要配置 API 令牌。

为 API 令牌命名，并定义其允许执行的范围。在本例中，API 令牌可以读取郁金香表，也可以写入郁金香表。如果不使用，API 令牌可以存档。

点击创建后，将给出 API 信息。请确保保存此信息，因为无法再次访问！

现在可以使用这些信息配置与 Tulip API 的连接。

测试 API

关闭弹出的信息，然后导航到 "创建 API 令牌 "选项旁边的 "API 文档 "按钮。

这将会带你进入一个页面，允许你使用创建的密钥测试 API。该页面还提供了文档，并举例说明了各种用途的请求体。

该页面还提供了从外部系统配置 API 请求所需的服务器 URL。要熟悉 API，请单击 "授权 "按钮。

该按钮将提供有关 API 配置的更多信息，以便进行测试。在字段中输入以下内容：

• 用户名：API 密钥
• 密码：密文

单击授权，然后就可以开始测试一些常见的表 HTTP 请求。

此页面中的每个选项都可以扩展和测试。每个请求都提供了相应响应的有用信息。

在该页面中，还有 Tulip 某些组件的模式信息。例如，要创建表格记录，了解每一列的适当 JSON 格式是很有用的。列模式示例如下所示：

使用过滤器查询

过滤器对于只提取您感兴趣的数据非常有用。这些筛选器的语法有时会比较麻烦。下面以请求记录的 GET 为例，概述了每种筛选器的语法，随后是一个完整的示例。

自定义字段的字段名前总是有一个五位数的字符串标识符。通过 GET 全部请求检查字段的真实名称后，最容易找到这些标识符。

• 例如"field"="maytq_scrap_count

参数值通常很简单。如果是文本值，请务必加上引号。

• 例如"arg"：15

匹配您要使用的函数类型。

• 例如"函数类型": "g greaterThan

完整的请求可能是这样的

https://brian.tulip.co/api/v3/tables/W2HPvyCZrjMMHTiip/records?limit=100&sortBy=\_sequenceNumber&sortDir=asc&filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"}]&filterAggregator=any

多个过滤器

在某些情况下，您可能需要在表中检查多个筛选器。在这种情况下，您可以将多个过滤器添加到过滤器对象中。如下所示

filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"},{"field": "maytq\_scrap\_reason", "arg": "scratch", "functionType": "equal"}]

示例

以下示例将介绍向郁金香 API 发送请求的过程。这些示例将使用 Postman 从 Tulip 发起请求。

获取表名和信息

该获取请求允许外部系统检索 Tulip 实例中所有表的 ID 和列信息。这种方法可以用来查找感兴趣的表，以便设置 POST 请求。

在 Postman 中，将授权设置为 Basic Auth，并输入 API 密钥和秘密。

现在，请求需要发送到正确的地方。在 Tulip 中，从 API 文档中找到你想要的请求。在本例中，请求是获取所有表信息。

为了获取请求 URL，请运行执行按钮，并检查请求信息。

然后就可以将此请求 URL 用作服务器 URL，以处理 Postman 的 GET 请求。

点击发送，请求将返回表中的所有信息。

创建表格记录

使用 POST 和上面的表 ID，可以从外部系统创建表记录。授权和标题将保持不变，但请求 URL 会有些不同。

首先，确定要创建记录的表。请求 URL 将始终遵循以下结构：

https://.tulip.co/api/v3/tables//records

输入后，请求还需要一个正文来正确处理 POST。列模式已在上面的测试部分给出，也可在 API 文档中找到。唯一完全必要的列是 ID 列。其他未添加的列在创建时将以空值存储在表记录中。将此内容添加为请求的正文。

提交时，Postman 会验证记录是否已创建。

找到要找的内容了吗？

你还可以前往community.tulip.co发布你的问题，或看看其他人是否也遇到过类似问题！