API设置（REST API）

斑斑低代码对外开放 API，你可以通过 API 访问斑斑的表单数据。

API 设置

打开应用，点击右上角“应用设置”。

点击左侧“API 设置”，可以进入设置界面。开启 API 服务后，当前应用的数据即可通过下方的 API 地址进行访问。

API 列表

其中，appId为应用 ID，formId为表单 ID（或表单别名），docId为数据 ID。

数据返回格式

返回数据包含以下字段：

• <font style="background-color:#f9ddb2;">data</font> 数据本身，可能有以下情况：
  • 单条数据，包含以下字段：
    • <font style="background-color:#f9ddb2;">id</font>``string
    • <font style="background-color:#f9ddb2;">updateTime</font>``int 时间戳
    • <font style="background-color:#f9ddb2;">createTime</font>``int 时间戳
    • <font style="background-color:#f9ddb2;">title</font> 表单中定义的字段 title
    • <font style="background-color:#f9ddb2;">description</font> 表单中定义的字段 description
    • … 表单中用户定义的其他字段，直接用字段的标题作为 key，可以是中文。
  • 列表数据，上述单条数据组成的数组
• <font style="background-color:#f9ddb2;">meta</font> 一些元数据（可扩展）
  • <font style="background-color:#f9ddb2;">pagination</font> 分页信息（可选）
    • <font style="background-color:#f9ddb2;">page</font>``int页数
    • <font style="background-color:#f9ddb2;">pageSize</font>``int分页大小
    • <font style="background-color:#f9ddb2;">pageCount</font>``int总页数
    • <font style="background-color:#f9ddb2;">total</font>``int数据总条数
• <font style="background-color:#f9ddb2;">error</font> 错误信息（可选）
  • <font style="background-color:#f9ddb2;">code</font>``int 错误码
  • <font style="background-color:#f9ddb2;">name</font>``string 错误类型
  • <font style="background-color:#f9ddb2;">message</font>``string 错误信息
  • <font style="background-color:#f9ddb2;">details</font>``object 详细信息

Key-Secret 校验

获取 key-secret

key 和 secret 可以在工作台的管理后台中获取。

请求参数

需要 Key-Secret 校验的请求，需要发送以下请求参数（GET 传参）：

比如 key 为vPQLpCHlXNKu，secret 为RaCBog1j8ruflI14amyeqYXm，则请求时的参数为：

key=vPQLpCHlXNKu&timestamp=1757391409&sign=36c0e2bbb0514d8df5144bda04f94765

请求示例

以下示例中，4j815fmhht0j是应用 ID，articles是表单别名。

获取列表数据

GET http://localhost:43334/api/v1/4j815fmhht0j/articles

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "data": [
    {
      "id": "u2i3s0pi1no7",
      "title": "BMK Paris Bamako",
      "内容": "",
      "updateTime": 1752047397644,
      "createTime": 1752047397644
    },
    {
      "id": "stykuonikdfl",
      "title": "Biscotte Restaurant",
      "内容": "",
      "updateTime": 1752047397644,
      "createTime": 1752047397644
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 2
    }
  }
}

获取单条数据

GET http://localhost:43334/api/v1/4j815fmhht0j/articles/stykuonikdfl

1
2
3
4
5
6
7
8
9
10

{
  "data": {
    "id": "stykuonikdfl",
    "title": "Biscotte Restaurant",
    "内容": "",
    "updateTime": 1752047397644,
    "createTime": 1752047397644
  },
  "meta": {}
}

新增一条数据

POST http://localhost:43334/api/v1/4j815fmhht0j/articles

1
2
3
4
5
6

{
  "data": {
    "title": "Biscotte Restaurant",
    "内容": ""
  }
}

1
2
3
4
5
6
7
8
9
10

{
  "data": {
    "id": "stykuonikdfl",
    "title": "Biscotte Restaurant",
    "内容": "",
    "updateTime": 1752047397644,
    "createTime": 1752047397644
  },
  "meta": {}
}

修改一条数据

PUT http://localhost:43334/api/v1/4j815fmhht0j/articles/stykuonikdfl

1
2
3
4
5
6

{
  "data": {
    "title": "Biscotte Restaurant",
    "内容": ""
  }
}

1
2
3
4
5
6
7
8
9
10

{
  "data": {
    "id": "stykuonikdfl",
    "title": "Biscotte Restaurant",
    "内容": "",
    "updateTime": 1752047397644,
    "createTime": 1752047397644
  },
  "meta": {}
}

删除一条数据

DELETE http://localhost:43334/api/v1/4j815fmhht0j/articles/stykuonikdfl 成功时仅返回状态码 204，无响应体

请求参数

数据过滤（Filters）

GET /api/v1/:appId/:formId?filters[:field][:operator]=:value

选择字段（Field selection）

可以用参数fields选择返回哪些字段，默认会返回除关系、子表之外的所有字段。

字段填充（Field Population）

REST API 默认不会返回关系字段、子表字段，可以用参数populate来填充。

排序（Sorting）

可以通过sort参数对数据进行排序。:asc为正序（默认方式，可不写），:desc为倒序。

分页（Pagination）

通过 page 分页

GET /api/v1/:appId/:formId?pagination[page]=1&pagination[pageSize]=10

通过 offset 分页

GET /api/v1/:appId/:formId?pagination[start]=0&pagination[limit]=10