跳到主要内容

introduction

1. 概述​

  • API (Application Programming Interface) = 应用程序接口
  • 提供了一个简单的方法来整合您的业务（应用）与任何外部系统的数据
  • 只需要用规定的格式调用 API 即可获取对应信息
  • API 严格遵循 REST 语义，使用 JSON 编码对象，并依赖标准 HTTP 代码来指示操作结果

2. API 请求的方式​

什么是请求：要调用 API 接口，则需要通过 URL 地址传输。URL 打开一次便是一次请求，刷新再来又算一次请求。

如何请求 API 接口：打开访问接口的 URL。URL 在请求时需要几个组成部分：

2.1 API 接口地址​

API 接口服务给外部访问的地址

请求方式：​

常见的有 GET，POST 和其他方式。

对于 GET 请求，所有参数通过拼接在 URL 之后传递。

对于 POST 请求，请求的主体必须是 JSON 格式，而且 HTTP header 的 Content-Type 需要设置为 application/json。

请求的参数：​

API 接口会根据您提供参数来处理对应的数据。

授权验证方式：​

在请求 API 时，需要验证您的请求。包括 Appkey/Secretkey 以及 Sign。这些讯息 API 服务商都会提供给您。

请求时需要传递的表头信息，属于系统级别的参数。正常情况下，我们不需要配置。如果需要配置，API 会特别说明。

Body：​

用来存储传递的数据。它在请求方式为 POST 时才需要配置，用来储存表单信息，有些授权验证的参数也可以存放在这里。 例如：通过 API 接口，讲表单数据新增到第三方系统内，表单的字段名称和字段值便会存放再 BODY 中。

总结，我们需要以下三部分来调用 API 接口：

  1. API URL 地址
  2. 传递的参数
  3. 授权验证身份

2.2 平台支持的模式​

基础模块​

接口内容包括：

  • 账户
  • 登录/验证
  • 消息

应用​

工作表​
  • 获取工作表结构信息 GET
应用权限组​
  • 创建应用权限组 POST
  • 获取应用权限组 GET
  • 删除应用权限组 DELETE
  • 修改应用权限组 PUT
  • 复制应用权限组 POST
选项集​
  • 新增选项集 POST
  • 获取选项集 GET
  • 编辑选项集 PUT

3. API 接口文档​

进入应用，点击【…】- 【应用管理】- 【API 文档】

image-20231127090846403

3.1 字段与控件类型对照表​

image-20231127091224110

控件 ID：自动生成的 ID，不能更改。通过 API 写入数据时需用控件 ID 代表本控件。

字段名称：用户为字段设置的名称。

说明：如果标志为只读，不支持写入和更新。

3.2 数据 API​

我们提供了不同接口，以满足数据的所有操作场景：

  • 获取列表 GET
  • 新建行记录 POST
  • 查询行记录 GET
  • 修改行记录 PUT
  • 删除行记录 DELETE
  • 批量更新记录 POST
  • 批量删除记录 DELETE

例如：我们需要新建一行记录，即通过 API 向工作表新增一行记录

image-20231127091755247

规则：

请求 URL：https://lancode.com/worksheet/api/v1/open/worksheets/{worksheetId}/records

参数可以直接复制提供的值

请求参数：

image-20231127092708538