跳到主要内容

v1 API 获取对外查询列表

API 使用者,可以通过本接口,获取自己创建的对外查询页面列表

功能免费版专业版/专业增强版企业基础版企业协作版企业高级版
对外查询✔️✔️✔️✔️

认证方式

V1 Bearer 认证方式

headers 设置

需要在请求中设置如下 headers

  • Content-Type: application/json
  • Accept: application/json
  • Authorization: Bearer YOUR_ACCESS_TOKEN

接口说明

  • 「对外查询」是一个公开页面:访问者填入查询条件,即可查到匹配的表单数据。
  • 对外查询归创建者所有,本接口只返回当前调用方创建的查询。使用账号级 API(Account Access Token)时,身份等同于账号 owner,因此返回的是 owner 创建的查询。
  • form_token 可只看某张表单下的查询。该 token 必须指向一张调用方能访问的表单,否则返回 404 —— 不会退化成「返回全部查询」。

接口描述

Request

GET https://jinshuju.net/api/v1/opensearch/queries
GET https://jinshuju.net/api/v1/opensearch/queries?form_token=FORM_TOKEN
参数名称是否必须类型说明
form_tokenString只返回该表单下的对外查询(Query 参数)

Response

{
"count": 1,
"data": [
{
"token": "o5qeEX",
"url": "https://demo.jinshuju.net/os/o5qeEX",
"name": "成绩查询",
"enabled": true,
"form_token": "wX7pQ2",
"created_at": "2026-09-07T16:11:37.532+08:00",
"searches_count": 128,
"views_count": 356
}
]
}
参数名称是否必须类型说明
countNumber本次返回的查询数量
dataArray对外查询数组
data[].tokenString对外查询 Token,用于后续获取/编辑
data[].urlString访问者打开的公开查询页地址;账号开启自定义域名(cname)时会使用自定义域名
data[].nameString查询页标题
data[].enabledBool查询页是否启用
data[].form_tokenString数据来源表单的 Token;来源表单已被删除时为 null
data[].created_atDateTime创建时间
data[].searches_countNumber累计查询次数
data[].views_countNumber累计访问次数

状态码

状态码说明
200获取成功
401未认证
402当前套餐不支持 V1 API
404form_token 指向的表单不存在或无权访问

示例代码

HTTP

GET https://jinshuju.net/api/v1/opensearch/queries

Content-Type: application/json
Accept: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

Python

import requests

access_token = 'YOUR_ACCESS_TOKEN'

response = requests.get(
'https://jinshuju.net/api/v1/opensearch/queries',
headers={'Authorization': f'Bearer {access_token}'},
params={'form_token': 'YOUR_FORM_TOKEN'} # 可选
)

print(response.text)