v1 API 获取表单单条数据

API使用者，可以通过本接口，获取自己单个表单的单条数据

功能	免费版	专业版/专业增强版	企业基础版	企业协作版	企业高级版
获取表单单条数据			✔️	✔️	✔️

认证方式

V1 Basic 认证方式

headers 设置

需要在请求中设置如下 headers

• Content-Type: application/json
• Accept: application/json
• Authorization: 放入上一步骤生成的CODE

接口说明

• 个人版用户/企业子账号用户，只可以获取 自己创建 的表单数据。无法获取共享的表单。
• 企业全局 API，可以获取整个企业所有表单的数据。

接口描述

Request

GET https://jinshuju.net/api/v1/forms/FORM_TOKEN/entries/SERIAL_NUMBER

参数名称	是否必须	类型	说明
FORM_TOKEN	是	String	表单Token
SERIAL_NUMBER	是	Number	数据序号

Response

{
    "form": "TOKEN",
    "form_name": "表单标题",
    "entry": {
        "serial_number": 1,
        "field_1": "张三",
        "field_2": "13000000000",
        "info_filling_duration": 28,
        "creator_name": "",
        "created_at": "2020-08-28T08:00:00.000Z",
        "updated_at": "2020-08-28T08:00:00.000Z"
    }
}

参数名称	是否必须	类型	说明
form	是	String	表单Token
form_name	是	String	表单标题
entry	是		本次请求创建成功的数据
entry.serial_number	是	Number	数据序号（标识符）
entry.field_*	是		对应字段的值
entry.creator_name	否	String	本条数据的填写者
entry.created_at	是	Date	数据提交时间
entry.updated_at	是	Date	数据最后一次变更时间

数据详细结构，请参考文档

注意：数据中的日期时间，使用的是 UTC 时间（例如："2021-09-28T02:59:42.539Z"），接受者需要自行转换为自己所需要的时区（例如北京时间）

示例代码

伪代码

api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"

credentials = api_key + ":" + api_secret

encoded_creadentials = base64_encode(credentials)

auth_header_payload = "Basic " + encoded_creadentials

headers = {"Authorization": auth_header_payload}

form_token = "YOUR_FORM_TOKEN"

serial_number = 1

http.get("https://jinshuju.net/api/v1/forms/${form_token}/entries/${serial_number}", headers)

HTTP

GET https://jinshuju.net/api/v1/forms/$FORM_TOKEN/entries/SERIAL_NUMBER

Content-Type: application/json
Accept: application/json
Authorization: Basic BASE_64_ENCODED_CREDENTIALS

Postman

GET https://jinshuju.net/api/v1/forms/$FORM_TOKEN/entries/$SERIAL_NUMBER

authorization 选择 `Basic Auth`

Username 输入 API Key
Password 输入 API Secret

Java

package net.jinshuju.v1api.demo;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Base64;

public class GetFormEntriesService {

    public void run(String apiKey, String apiSecret, String formToken, int entrySerialNumber) throws IOException {
        String authHeaderPayload = getAuthHeaderPayload(apiKey, apiSecret);

        BufferedReader httpResponseReader = null;
        try {
            URL apiEndpointUrl = new URL("https://jinshuju.net/api/v1/forms/" + formToken + "/entries/" + entrySerialNumber);
            HttpURLConnection urlConnection = (HttpURLConnection) apiEndpointUrl.openConnection();
            urlConnection.setRequestMethod("GET");
            urlConnection.addRequestProperty("Authorization", authHeaderPayload);

            httpResponseReader = new BufferedReader(new InputStreamReader(urlConnection.getInputStream(), "UTF-8"));
            String lineRead;
            while ((lineRead = httpResponseReader.readLine()) != null) {
                System.out.println(lineRead);
            }
        } finally {
            if (httpResponseReader != null) {
                try {
                    httpResponseReader.close();
                } catch (IOException ignored) {
                }
            }
        }
    }

    private String getAuthHeaderPayload(String apiKey, String apiSecret) {
        String credentials = apiKey + ":" + apiSecret;

        String base64EncodedCredentials = Base64.getEncoder().encodeToString(credentials.getBytes());
        return "Basic " + base64EncodedCredentials;
    }

}

Python

import requests

api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'

form_token = 'YOUR_FORM_TOKEN'
entry_serial_number = 1

api_endpoint_url = 'https://jinshuju.net/api/v1/forms/' + form_token + '/entries/' + entry_serial_number

response = requests.get(api_endpoint_url, auth = (api_key, api_secret))

print(response.text)

Ruby

require 'net/http'
require 'uri'

form_token = 'YOUR_FORM_TOKEN'
entry_serial_number = 1

uri = URI.parse("https://jinshuju.net/api/v1/forms/#{form_token}/entries/#{entry_serial_number}")
api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'

request = Net::HTTP::Get.new(uri)
request.basic_auth(api_key, api_secret)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts(response.body)