### Example JSON Load for Single Entry

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

This is an example of the JSON structure returned when fetching a single entry.

```json
{
    "serial_number": 1,
    "field_1": "小金",
    "field_16": "金数据",
    "field_2": "2jYk",
    "field_4": {
        "value": "18629058968",
        "verified": true
    },
    "field_3": [
        "zI63",
        "uN9L"
    ],
    "field_17": "roody@jinshuju.com",
    "field_5": [
        "7oLf",
        "vQki"
    ],
    "field_10": "1lq3",
    "field_11": "小金的应用场景",
    "field_12": "金数据在各行各业的用法",
    "field_6": "金数据有没有一些更加高级的技巧呢？",
    "field_7": "",
    "field_8": "1. 能否参加\n2. 哪个公司？\n3. 金数据的使用情况",
    "field_15": "",
    "field_18": "",
    "creator_name": "o王琰o",
    "updater_name": "",
    "created_at": "2016-02-17T11:40:31.524Z",
    "updated_at": "2016-02-17T11:40:31.524Z",
    "info_remote_ip": "123.139.21.4",
    "info_platform": "Macintosh",
    "info_os": "OS X 10.11.3",
    "info_browser": "Chrome 48.0.2564.109"
}
```

--------------------------------

### Form Status Response Example

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

An example of the JSON response for the 'Get Form Status' endpoint, indicating the form's open state, permission, and entry count.

```JSON
{
    "is_open": true,
    "permission": "public",
    "entries_count": 60
}
```

--------------------------------

### Copy Form Response Example

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

This is an example of the JSON response received after successfully copying a form. It includes details of the newly created form such as its ID, token, name, and fields.

```JSON
{
  "id": "58512d8159601539b83e75fa",
  "token": "AyEpBI",
  "name": "[新]学习小组第一期话题投票",
  "entries_count": 0,
  "shared": false,
  "description": "这是一个大家都可以加入或旁听的学习小组，",
  "created_at": "2016-12-14T11:31:14.255Z",
  "updated_at": "2016-12-14T11:31:15.325Z",
  "fields": [
    {
      "type": "single_line_text",
      "label": "你的大名",
      "api_code": "field_1",
      "notes": "",
      "validations": {},
      "predefined_value": null,
      "private": false
    },
    {
      "type": "multiple_choice",
      "label": "请选择你喜欢的话题",
      "api_code": "field_2",
      "notes": "",
      "validations": {},
      "private": false,
      "choices": [
        {
          "name": "如何理解产品经理这个角色",
          "value": "gRpI",
          "hidden": false
        },
        {
          "name": "如何提高碎片化阅读的效率",
          "value": "gmIV",
          "hidden": false
        },
        {
          "name": "利用Excel进行数据分析的技巧",
          "value": "qTXj",
          "hidden": false
        },
        {
          "name": "如何快速阅读一本书",
          "value": "OASQ",
          "hidden": false
        },
        {
          "name": "QA进阶。相信我，你们都不需要入门",
          "value": "H2YM",
          "hidden": false
        },
        {
          "name": "《无价》读书心得分享",
          "value": "Ud2N",
          "hidden": false
        },
        {
          "name": "设计中关于字体的二三事",
          "value": "V2nl",
          "hidden": false
        },
        {
          "name": "金数据产品运行的基本原理。",
          "value": "BxvN",
          "hidden": false
        },
        {
          "name": "金数据设计的基本原则和思考",
          "value": "rQAm",
          "hidden": false
        }
      ],
      "allow_other": false
    }
  ],
  "setting": {
    "icon": "form-icon-chart",
    "color": "#BB87AF",
    "open_rule": "open",
    "permission": "public",
    "result_state": "closed",
    "result_url": null,
    "search_state": "closed",
    "search_url": null,
    "push_url": null,
    "success_redirect_url": null,
    "success_redirect_fields": []
  }
}
```

--------------------------------

### Pagination Example with Per Page Parameter

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Shows how to request a specific number of items per page for paginated API responses, up to a maximum of 50.

```http
GET https://api.jinshuju.net/v4/forms?access_token=...&per_page=50
```

--------------------------------

### Get Current User Basic Info API Response

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Example JSON response for the API endpoint that fetches basic information about the currently authenticated user.

```json
{
  "email": "email@mail.com",
  "nickname": "email@mail.com",
  "avatar": "https://dn-jsjpub.qbox.me/av/517aa4fe24290aa13800001395.jpg",
  "uid": "fk3a9EvKTu3KKmTqa2CisQ"
}
```

--------------------------------

### Get Form Settings

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves the settings for a specific form. Requires the `form_setting` scope.

```json
{
    "icon": "fontello-sound",
    "color": "#afa373",
    "open_rule": "open",
    "permission": "public",
    "result_state": "closed",
    "result_url": null,
    "search_state": "closed",
    "search_url": null,
    "push_url": null,
    "success_redirect_url": "https://baidu.com",
    "success_redirect_fields": [
        "field_2",
        "field_1"
    ]
}
```

--------------------------------

### 配置SDK打开窗口的方式 (tab)

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

在 `gdsdk.ready` 函数中调用 `gdsdk.config` 方法，并设置 `open` 选项为 'tab'，以配置SDK打开的窗口在新标签页中打开。

```javascript
gdsdk.ready = function() {
  gdsdk.config({
      open: 'tab'
  });
};
```

--------------------------------

### Get Enterprise User List API Response

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Example JSON response structure for the API endpoint that retrieves a list of users within an enterprise.

```json
{
  "users": [
    {
      "email": "email@mail.com",
      "nickname": "email@mail.com",
      "avatar": "https://dn-jsjpub.qbox.me/av/517aa4fe24290aa13800001395.jpg",
      "uid": "fk3a9EvKTu3KKmTqa2CisQ",
      "openid": "fk3a9EvKTu3KKmTqa2CisQ",
      "role": "admin",
      "status": "active",
      "authentications": [
        {
          "provider": "identity",
          "uid": "uid"
        }
      ]
    }
  ]
}
```

--------------------------------

### 配置SDK打开窗口的方式 (inline)

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

在 `gdsdk.ready` 函数中调用 `gdsdk.config` 方法，设置 `open` 为 'inline' 并提供 `containerId`，以将SDK页面嵌入到指定的div容器中。

```javascript
gdsdk.ready = function() {
  gdsdk.config({
    open: 'inline',
    containerId: 'gd_sdk_container',
  });
};
```

--------------------------------

### SDK Initialization

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

Include this script in your HTML to initialize the Jinshuju SDK. Replace <your_sdk_appid> with your actual SDK App ID.

```APIDOC
## SDK Initialization

### Description
Include this script in your HTML to initialize the Jinshuju SDK. Replace `<your_sdk_appid>` with your actual SDK App ID.

### Code
```javascript
<script type='text/javascript'>
  (function (w, d, t, s, n) {
    w[n] = w[n] || function () { (w[n].q = w[n].q || []).push(arguments); };
    var a, x = d.getElementsByTagName(t)[0];
    if (d.getElementById(n)) {return;}
    a = document.createElement(t); a.id = n; a.type = 'text/javascript'; a.async = true; a.src = s;
    x.parentNode.insertBefore(a, x);
  })(window, document, 'script', 'https://jinshuju.net/sdk.js?appid=<your_sdk_appid>&v=1.0.0', 'gdsdk');
<script>
```
```

--------------------------------

### 配置表单字段显示和隐藏

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

在 `gdsdk.ready` 函数中调用 `gdsdk.config` 方法，使用 `fields` 选项来配置 `only` 和 `except` 列表，以控制表单中显示的字段。

```javascript
gdsdk.ready = function() {
  gdsdk.config({
    fields: {only: ['TextField', 'TextArea', 'RadioButton', 'CheckBox'],
             except: ['NpsField', 'DropDown', 'NameField']}
 });
};
```

--------------------------------

### Get Current User Account Info API Response

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Example JSON response for the API endpoint that retrieves detailed account information for the current user, including custom domain.

```json
{
  "email": "email@mail.com",
  "custom_domain": 'forms.example.com'
}
```

--------------------------------

### 配置SDK显示的字段范围

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-sdk.md

通过`gdsdk.config`方法配置`fields`选项，使用`only`和`except`来控制在SDK中显示或隐藏的字段。如果`only`和`except`同时使用，系统会取两者交集。

```javascript
gdsdk.ready = function() {
  gdsdk.config({
    fields: {only: ['single_line_text', 'goods', 'cascade_drop_down'],
             except: ['single_line_text', 'paragraph_text', 'single_choice']}
 });
};
```

--------------------------------

### Get Multiple Entries

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Retrieves all submitted entries for a given form.

```APIDOC
## GET /v4/forms/{form_token}/entries

### Description
Retrieves all submitted entries for a given form.

### Method
GET

### Endpoint
`https://api.jinshuju.com/v4/forms/{form_token}/entries`

### Parameters
#### Path Parameters
- **form_token** (string) - Required - The token of the form.

#### Query Parameters
- **access_token** (string) - Required - User's access token.

### Response
#### Success Response (200)
Returns an array of submitted entries, where each entry contains field data and submission metadata.

### Response Example
```json
[
    {
        "serial_number": 1,
        "field_1": "小金",
        "field_16": "金数据",
        "field_2": "2jYk",
        "field_4": {
            "value": "18629058968",
            "verified": true
        },
        "field_3": [
            "zI63",
            "uN9L"
        ],
        "field_17": "roody@jinshuju.com",
        "field_5": [
            "7oLf",
            "vQki"
        ],
        "field_10": "1lq3",
        "field_11": "小金的应用场景",
        "field_12": "金数据在各行各业的用法",
        "field_6": "金数据有没有一些更加高级的技巧呢？",
        "field_7": "",
        "field_8": "1. 能否参加\n2. 哪个公司？\n3. 金数据的使用情况",
        "field_15": "",
        "field_18": "",
        "creator_name": "o王琰o",
        "updater_name": "",
        "created_at": "2016-02-17T11:40:31.524Z",
        "updated_at": "2016-02-17T11:40:31.524Z",
        "info_remote_ip": "123.139.21.4",
        "info_platform": "Macintosh",
        "info_os": "OS X 10.11.3",
        "info_browser": "Chrome 48.0.2564.109"
    }
]
```
```

--------------------------------

### Get Form Settings

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Retrieves the settings for a specific form. Requires `form_setting` scope.

```APIDOC
## GET /v4/forms/{form_id}/setting

### Description
Retrieves the settings of a specific form.

### Method
GET

### Endpoint
`https://api.jinshuju.com/v4/forms/RygpW3/setting?access_token=...`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - Your access token.

### Response
#### Success Response (200)
- **icon** (string) - The icon associated with the form.
- **color** (string) - The color theme of the form.
- **open_rule** (string) - The rule for opening the form.
- **permission** (string) - The permission level of the form.
- **result_state** (string) - The state of the form results.
- **result_url** (string) - The URL for form results.
- **search_state** (string) - The state of form search.
- **search_url** (string) - The URL for form search.
- **push_url** (string) - The URL for data push.
- **success_redirect_url** (string) - The URL to redirect to after successful submission.
- **success_redirect_fields** (array) - Fields to include in the redirect URL.

### Response Example
```json
{
    "icon": "fontello-sound",
    "color": "#afa373",
    "open_rule": "open",
    "permission": "public",
    "result_state": "closed",
    "result_url": null,
    "search_state": "closed",
    "search_url": null,
    "push_url": null,
    "success_redirect_url": "https://baidu.com",
    "success_redirect_fields": [
        "field_2",
        "field_1"
    ]
}
```
```

--------------------------------

### 创建新表单

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-sdk.md

你可以在数据属性中使用`data-role="gd-sdk"`，或直接调用`gdsdk.createForm()`方法来创建一个新表单。

```APIDOC
```html
<button data-role="gd-sdk">创建新表单</button>
```

```javascript
gdsdk.createForm()
```
```

--------------------------------

### Accessing API with Access Token

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Demonstrates how to include an access token in API requests, either directly in the URL or via the Authorization header.

```http
GET https://api.jinshuju.net/v4/forms?access_token=...
```

```http
Authorization: bearer OAUTH-TOKEN
```

```bash
curl -H "Authorization: bearer OAUTH-TOKEN" https://api.jinshuju.net/v4/forms
```

--------------------------------

### Get Form Settings

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Retrieve the settings for a specific form. Requires the `form_setting` scope.

```http
get https://api.jinshuju.com/v4/forms/RygpW3/setting?access_token=...
```

--------------------------------

### Get Contact Tags

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves a list of contact tags. Requires 'read_contacts' scope.

```APIDOC
## GET /v4/contact_tags

### Description
Fetches a list of tags associated with contacts.

### Method
GET

### Endpoint
`https://api.jinshuju.net/v4/contact_tags?access_token=...`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.
```

--------------------------------

### 可配置的窗口打开选项

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

列出了SDK支持的窗口打开方式选项：'tab', 'window', 'inline'。

```javascript
'tab', 'window', 'inline'
```

--------------------------------

### 控制SDK打开窗口在浏览器新tab中还是新窗口

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-sdk.md

你可以配置在引用的SDK中打开窗口在浏览器新tab中还是新窗口。

```APIDOC
```javascript
gdsdk.ready = function() {
  gdsdk.config({
      open: 'tab'
  });
};
```

可配置的打开窗口方式如下：

```
'tab', 'window'
```
```

--------------------------------

### 创建新表单 (JavaScript)

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

直接调用 `gdsdk.createForm()` 方法来创建一个新表单。

```javascript
gdsdk.createForm()
```

--------------------------------

### Get Form Settings

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves the current settings for a specific form. Requires 'form_setting' scope.

```APIDOC
## GET /v4/forms/{form_id}/setting

### Description
Fetches the configuration settings for a given form.

### Method
GET

### Endpoint
`https://api.jinshuju.net/v4/forms/RygpW3/setting?access_token=...`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.
```

--------------------------------

### 创建新表单 (HTML)

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

通过在HTML元素上设置 `data-role="gd-sdk"` 属性来触发创建新表单的功能。

```html
<button data-role="gd-sdk">创建新表单</button>
```

--------------------------------

### Get Contact Tags List

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves a list of contact tags. Requires the `read_contacts` scope.

```json
[
  {
    "created_at": "2022-05-25T01:09:06.284+08:00",
    "updated_at": "2022-05-25T01:09:06.284+08:00",
    "name": "小金",
    "contacts_count": 20
  }
]
```

--------------------------------

### Get Form Status

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Retrieves the current status of a form, including whether it is open and the number of entries.

```APIDOC
## GET /v4/forms/{form_token}/status

### Description
Retrieves the current status of a form.

### Method
GET

### Endpoint
`https://api.jinshuju.com/v4/forms/{form_token}/status`

### Parameters
#### Path Parameters
- **form_token** (string) - Required - The token of the form.

#### Query Parameters
- **access_token** (string) - Required - User's access token.

### Response
#### Success Response (200)
Returns the form's status, including `is_open`, `permission`, and `entries_count`.

### Response Example
```json
{
    "is_open": true,
    "permission": "public",
    "entries_count": 60
}
```
```

--------------------------------

### 可配置的表单字段列表

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

列出了所有可以在SDK中配置显示或隐藏的表单字段类型。

```javascript
['TextField','TextArea','RadioButton','CheckBox','ImageRadioButton','ImageCheckBox','DropDown','CascadeDropDown','NumberField','AttachmentField','TimeField','DateField','PageBreak','SectionBreak','LinkField','GeoField','MultipleBlanksField','GoodsField','BasicGoodsField','NameField','MobileField','EmailField','TelephoneField','AddressField','MatrixField','LikertField','TableField','FormAssociation','RatingField','NpsField','SortField','ESignatureField','FormulaField','ReservationField','Divider','StyledText','ImageText','Carousel','Timer','ImageGroup','WidgetMap','WidgetContact','WidgetVideo']
```

--------------------------------

### Get Enterprise User List

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves a list of users within an enterprise. Requires the 'users' scope.

```APIDOC
## GET /v4/users

### Description
Retrieves a list of users within the enterprise.

### Method
GET

### Endpoint
https://api.jinshuju.net/v4/users

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication. Can be a personal access token or an enterprise access token.

### Response
#### Success Response (200)
- **users** (array) - A list of user objects.
  - **email** (string) - User's email address.
  - **nickname** (string) - User's nickname.
  - **avatar** (string) - URL to the user's avatar.
  - **uid** (string) - User's unique identifier.
  - **openid** (string) - Open ID of the user.
  - **role** (string) - User's role (e.g., 'admin').
  - **status** (string) - User's status (e.g., 'active').
  - **authentications** (array) - List of user authentications.
    - **provider** (string) - Authentication provider.
    - **uid** (string) - Authentication provider's user ID.

### Response Example
```json
{
  "users": [
    {
      "email": "email@mail.com",
      "nickname": "email@mail.com",
      "avatar": "https://dn-jsjpub.qbox.me/av/517aa4fe24290aa13800001395.jpg",
      "uid": "fk3a9EvKTu3KKmTqa2CisQ",
      "openid": "fk3a9EvKTu3KKmTqa2CisQ",
      "role": "admin",
      "status": "active",
      "authentications": [
        {
          "provider": "identity",
          "uid": "uid"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Get Single Entry

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Retrieves a single entry from a form using its serial number. Requires `read_entries` scope.

```APIDOC
## GET /v4/forms/{form_id}/entries/{serial_number}

### Description
Retrieves a single entry from a specified form.

### Method
GET

### Endpoint
`https://api.jinshuju.com/v4/forms/RygpW3/entries/<序列号>?access_token=...`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - Your access token.

#### Path Parameters
- **serial_number** (integer) - Required - The serial number of the entry to retrieve.

### Response
#### Success Response (200)
- **serial_number** (integer) - The serial number of the entry.
- **field_1** (string) - Example field data.
- **field_16** (string) - Example field data.
- **field_2** (string) - Example field data.
- **field_4** (object) - Example field data with nested properties.
- **field_3** (array) - Example array field data.
- **field_17** (string) - Example email field data.
- **field_5** (array) - Example array field data.
- **field_10** (string) - Example field data.
- **field_11** (string) - Example field data.
- **field_12** (string) - Example field data.
- **field_6** (string) - Example field data.
- **field_7** (string) - Example field data.
- **field_8** (string) - Example field data.
- **field_15** (string) - Example field data.
- **field_18** (string) - Example field data.
- **creator_name** (string) - The name of the entry creator.
- **updater_name** (string) - The name of the entry updater.
- **created_at** (string) - The timestamp when the entry was created.
- **updated_at** (string) - The timestamp when the entry was last updated.
- **info_remote_ip** (string) - The IP address from which the entry was submitted.
- **info_platform** (string) - The platform used for submission.
- **info_os** (string) - The operating system used for submission.
- **info_browser** (string) - The browser used for submission.

### Response Example
```json
{
    "serial_number": 1,
    "field_1": "小金",
    "field_16": "金数据",
    "field_2": "2jYk",
    "field_4": {
        "value": "18629058968",
        "verified": true
    },
    "field_3": [
        "zI63",
        "uN9L"
    ],
    "field_17": "roody@jinshuju.com",
    "field_5": [
        "7oLf",
        "vQki"
    ],
    "field_10": "1lq3",
    "field_11": "小金的应用场景",
    "field_12": "金数据在各行各业的用法",
    "field_6": "金数据有没有一些更加高级的技巧呢？",
    "field_7": "",
    "field_8": "1. 能否参加\n2. 哪个公司？\n3. 金数据的使用情况",
    "field_15": "",
    "field_18": "",
    "creator_name": "o王琰o",
    "updater_name": "",
    "created_at": "2016-02-17T11:40:31.524Z",
    "updated_at": "2016-02-17T11:40:31.524Z",
    "info_remote_ip": "123.139.21.4",
    "info_platform": "Macintosh",
    "info_os": "OS X 10.11.3",
    "info_browser": "Chrome 48.0.2564.109"
}
```
```

--------------------------------

### 支持JWT登录和静默注册

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-sdk.md

SDK中支持JWT登录用户和静默注册用户。JWT中需包含请求登录用户的uid。如请求登录的用户没有注册，则会在金数据系统中静默注册。注册用户用户名为：`User_<JWT中的uid>`邮箱为：`<JWT中的uid>@fake.<Subdomain>.com`；如请求登录的用户已经注册，则会直接登录金数据系统。

```APIDOC
```html
<button data-role="gd-sdk" data-jwt="<jwt>" data-form="Dv6jVf">修改</button>
```
```javascript
gdsdk.createForm("<jwt>")
gdsdk.editForm("<form_token>", "<jwt>")
```
```

--------------------------------

### Get Single Entry Data

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Use this endpoint to retrieve a single entry from a form. Requires the `read_entries` scope.

```http
GET https://api.jinshuju.com/v4/forms/RygpW3/entries/<序列号>?access_token=...
```

--------------------------------

### Get Single Entry

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves a single entry from a form using its serial number. Requires 'read_entries' scope.

```APIDOC
## GET /v4/forms/{form_id}/entries/{serial_number}

### Description
Retrieves a single entry from a specified form using its unique serial number.

### Method
GET

### Endpoint
`https://api.jinshuju.net/v4/forms/RygpW3/entries/<序列号>?access_token=...`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.

#### Path Parameters
- **serial_number** (string) - Required - The serial number of the entry to retrieve.
```

--------------------------------

### 获取当前用户基本信息

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

使用curl命令发送GET请求到API的/me端点，并附带access_token参数来获取当前用户的基本信息。

```bash
curl https://api.jinshuju.com/v4/me?access_token=...
```

--------------------------------

### 可配置的表单字段列表

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-sdk.md

列出了金数据SDK中可配置的表单字段类型。

```json
["single_line_text", "paragraph_text", "single_choice", "multiple_choice",
"likert", "matrix", "number", "time", "date", "drop_down", "section_break",
"page_break", "link", "rating", "cascade_drop_down", "attachment",
"form_association", "formula", "mobile", "email", "address",
"geo", "phone", "goods", "table"]
```

--------------------------------

### Get Edit Link for Entry

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Generates an edit link for a specific entry within a form. Requires 'write_entries' scope.

```APIDOC
## GET /v4/forms/{form_id}/entries/{serial_number}/edit

### Description
Provides a link to edit a specific entry in a form. This link can be used to redirect users to an editing interface.

### Method
GET

### Endpoint
`https://api.jinshuju.net/v4/forms/RygpW3/entries/<序列号>/edit?access_token=...`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.

#### Path Parameters
- **serial_number** (string) - Required - The serial number of the entry to get the edit link for.

### Redirects To
`https://jinshuju.net/f/RygpW3/e/<token>/edit?&t=...`
```

--------------------------------

### Configure Window Open Behavior

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

Set how SDK-opened windows behave (new tab, new window, or inline iframe) using the `open` option in `gdsdk.config()`. For `inline` mode, specify a `containerId`.

```APIDOC
## Configure Window Open Behavior

### Description
Set how SDK-opened windows behave (new tab, new window, or inline iframe) using the `open` option in `gdsdk.config()`. For `inline` mode, specify a `containerId`.

### JavaScript Example (New Tab)
```javascript
gdsdk.ready = function() {
  gdsdk.config({
      open: 'tab'
  });
};
```

### JavaScript Example (Inline iframe)
```javascript
gdsdk.ready = function() {
  gdsdk.config({
    open: 'inline',
    containerId: 'gd_sdk_container',
  });
};
```

### Available Options
```javascript
'tab', 'window', 'inline'
```
```

--------------------------------

### Get Edit Link for Single Entry

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves the edit link for a single entry in a form. Requires the `write_entries` scope.

```http
GET https://api.jinshuju.net/v4/forms/RygpW3/entries/<序列号>/edit?access_token=...
```

--------------------------------

### Get Single Entry Data

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves a single entry from a form using its serial number. Requires the `read_entries` scope.

```json
{
    "serial_number": 1,
    "field_1": "小金",
    "field_16": "金数据",
    "field_2": "2jYk",
    "field_4": {
        "value": "18629058968",
        "verified": true
    },
    "field_3": [
        "zI63",
        "uN9L"
    ],
    "field_17": "roody@jinshuju.net",
    "field_5": [
        "7oLf",
        "vQki"
    ],
    "field_10": "1lq3",
    "field_11": "小金的应用场景",
    "field_12": "金数据在各行各业的用法",
    "field_6": "金数据有没有一些更加高级的技巧呢？",
    "field_7": "",
    "field_8": "1. 能否参加\n2. 哪个公司？\n3. 金数据的使用情况",
    "field_15": "",
    "field_18": "",
    "creator_name": "o王琰o",
    "updater_name": "",
    "created_at": "2016-02-17T11:40:31.524Z",
    "updated_at": "2016-02-17T11:40:31.524Z",
    "info_remote_ip": "123.139.21.4",
    "info_platform": "Macintosh",
    "info_os": "OS X 10.11.3",
    "info_browser": "Chrome 48.0.2564.109"
}
```

--------------------------------

### 申请企业授权

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

通过GET请求转向到金数据的企业授权页面，用于申请企业的验证。需要提供client_id, redirect_uri, response_type, scope, 和 state 参数。

```http
GET https://account.jinshuju.com/org_oauth/authorize
```

--------------------------------

### Get Form Details

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves detailed information about a specific form, including its fields and settings. Requires 'forms' scope.

```APIDOC
## GET /v4/forms/{form_token}

### Description
Retrieves detailed information about a specific form, including its fields and settings. Requires 'forms' scope.

### Method
GET

### Endpoint
https://api.jinshuju.net/v4/forms/RygpW3

### Parameters
#### Query Parameters
- **access_token** (string) - Required - Your API access token.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the form.
- **token** (string) - The unique token for the form.
- **name** (string) - The name of the form.
- **entries_count** (integer) - The number of entries submitted to the form.
- **shared** (boolean) - Indicates if the form is shared.
- **description** (string) - A description of the form.
- **created_at** (string) - The timestamp when the form was created.
- **updated_at** (string) - The timestamp when the form was last updated.
- **fields** (array) - An array of field objects, each describing a form field.
  - **type** (string) - The type of the form field (e.g., 'single_line_text', 'single_choice').
  - **label** (string) - The label displayed for the form field.
  - **api_code** (string) - The API code for the form field.
  - **notes** (string) - Additional notes for the form field.
  - **predefined_value** (string) - A predefined value for the field.
  - **private** (boolean) - Indicates if the field is private.
  - **validations** (object) - Validation rules for the field.
    - **required** (boolean) - Indicates if the field is required.
  - **choices** (array) - An array of choices for choice-based fields.
    - **name** (string) - The name of the choice.
    - **value** (string) - The value of the choice.
  - **allow_other** (boolean) - Indicates if an 'other' option is allowed for choice fields.

### Response Example
```json
{
    "id": "56b2f86ca3f5206d76000143",
    "token": "TivBsE",
    "name": "小金俱乐部活动报名",
    "entries_count": 0,
    "shared": false,
    "description": "2016年小金俱乐部第一站来到了上海，这一次我们把上海当成主场。如果你之前遗憾没有参加小金的北京发布会",
    "created_at": "2016-02-04T07:06:20.559Z",
    "updated_at": "2016-02-04T07:10:20.559Z",
    "fields": [
        {
            "type": "single_line_text",
            "label": "姓名",
            "api_code": "field_1",
            "notes": "",
            "predefined_value": "",
            "private": false,
            "validations": {
                "required": true
            }
        },
        {
            "type": "single_choice",
            "label": "称呼",
            "api_code": "field_2",
            "notes": "",
            "predefined_value": null,
            "private": false,
            "validations": {
                "required": true
            },
            "choices": [
                {
                    "name": "先生",
                    "value": "2jYk"
                },
                {
                    "name": "女士",
                    "value": "pIjs"
                },
                {
                    "name": "保密",
                    "value": "yofb"
                }
            ],
            "allow_other": false
        }
    ]
}
```
```

--------------------------------

### 整个企业申请验证

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

用于整个企业的授权。授权后可以访问整个企业的资源。请将client_id和redirect_uri替换为你的应用信息。

```http
GET https://account.jinshuju.net/org_oauth/authorize?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...
```

--------------------------------

### 申请用户授权

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

通过GET请求转向到金数据的授权页面，用于申请企业中用户的验证。需要提供client_id, redirect_uri, response_type, scope, 和 state 参数。

```http
GET https://account.jinshuju.com/oauth/authorize
```

--------------------------------

### Get Current User Account Information

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves account information for the currently authenticated user. Requires the 'profile' scope.

```APIDOC
## GET /v4/profile

### Description
Retrieves account information for the currently authenticated user.

### Method
GET

### Endpoint
https://api.jinshuju.net/v4/profile

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.

### Response
#### Success Response (200)
- **email** (string) - User's email address, globally unique.
- **custom_domain** (string) - Custom domain information. Returns the value set in the user's personal center if available, otherwise empty.

### Response Example
```json
{
  "email": "email@mail.com",
  "custom_domain": 'forms.example.com'
}
```
```

--------------------------------

### Get Multiple Entries

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Fetch multiple entries from a form. This endpoint requires the `read_entries` scope. Replace `...` with your access token.

```HTTP
GET https://api.jinshuju.com/v4/forms/RygpW3/entries?access_token=...
```

--------------------------------

### 控制表单显示和隐藏的字段

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-sdk.md

你可以配置在引用的SDK中显示和隐藏的字段列表。配置后的字段将不出现在新建和编辑的表单中。如only和except同时使用，系统会取两者交集显示在SDK中。

```APIDOC
```javascript
gdsdk.ready = function() {
  gdsdk.config({
    fields: {only: ['single_line_text', 'goods', 'cascade_drop_down'],
             except: ['single_line_text', 'paragraph_text', 'single_choice']}
 });
};
```

可配置的字段列表如下：

```json
["single_line_text", "paragraph_text", "single_choice", "multiple_choice",
"likert", "matrix", "number", "time", "date", "drop_down", "section_break",
"page_break", "link", "rating", "cascade_drop_down", "attachment",
"form_association", "formula", "mobile", "email", "address",
"geo", "phone", "goods", "table"]
```
```

--------------------------------

### 创建表单规则 (JavaScript)

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

调用 `gdsdk.createFieldRule("<form_token>")` 方法来创建表单字段规则。请将 `<form_token>` 替换为您的表单Token。

```javascript
gdsdk.createFieldRule("Dv6jVf")
```

--------------------------------

### Get Contacts

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves a list of contacts. Supports filtering by mobile, email, weixin_openid, and creation/update times. Requires 'read_contacts' scope.

```APIDOC
## GET /v4/contacts

### Description
Fetches a list of contacts, with options to filter by various criteria.

### Method
GET

### Endpoint
`https://api.jinshuju.net/v4/contacts?access_token=...`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.
- **mobile** (string) - Optional - Filter contacts by mobile number.
- **email** (string) - Optional - Filter contacts by email address.
- **weixin_openid** (string) - Optional - Filter contacts by WeChat openid.
- **start_created_at** (string) - Optional - Filter contacts created after this timestamp.
- **end_created_at** (string) - Optional - Filter contacts created before this timestamp.
- **start_updated_at** (string) - Optional - Filter contacts updated after this timestamp.
- **end_updated_at** (string) - Optional - Filter contacts updated before this timestamp.
```

--------------------------------

### Get Contacts List

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves a list of contacts. Supports filtering by mobile, email, weixin_openid, and date ranges. Requires the `read_contacts` scope.

```json
[
  {
    "created_at": "2022-05-25T01:09:06.284+08:00",
    "updated_at": "2022-05-25T01:09:06.284+08:00",
    "name": "小金",
    "name_pinyin": "XIAOJIN",
    "comment": "",
    "mobiles": [{"value": "152********"}],
    "emails": ["email@mail.com"],
    "addresses": [],
    "weixin_info": {},
    "tags": []
  }
]
```

--------------------------------

### Create New Form

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

Initiate the creation of a new form. This can be triggered by a button with `data-role="gd-sdk"` or by calling the `gdsdk.createForm()` method.

```APIDOC
## Create New Form

### Description
Initiate the creation of a new form. This can be triggered by a button with `data-role="gd-sdk"` or by calling the `gdsdk.createForm()` method.

### HTML Example
```html
<button data-role="gd-sdk">创建新表单</button>
```

### JavaScript Example
```javascript
gdsdk.createForm()
```
```

--------------------------------

### 支持JWT登录 (JavaScript)

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-sdk.md

在调用SDK方法时，传入JWT作为参数，以支持JWT登录。例如 `gdsdk.createForm("<jwt>")`。

```javascript
gdsdk.createForm("<jwt>")
```

```javascript
gdsdk.editForm("<form_token>", "<jwt>")
```

```javascript
gdsdk.createFieldRule("<form_token>", "<jwt>")
```

--------------------------------

### Get Current User Basic Information

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/jinshuju-net-api.md

Retrieves basic information about the currently authenticated user. Requires 'public' scope or no specific scope.

```APIDOC
## GET /v4/me

### Description
Retrieves basic information about the currently authenticated user.

### Method
GET

### Endpoint
https://api.jinshuju.net/v4/me

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The access token for authentication.

### Response
#### Success Response (200)
- **email** (string) - User's email address, globally unique.
- **nickname** (string) - User's nickname.
- **avatar** (string) - URL to the user's avatar.
- **uid** (string) - User's unique identifier.

### Response Example
```json
{
  "email": "email@mail.com",
  "nickname": "email@mail.com",
  "avatar": "https://dn-jsjpub.qbox.me/av/517aa4fe24290aa13800001395.jpg",
  "uid": "fk3a9EvKTu3KKmTqa2CisQ"
}
```
```

--------------------------------

### 初始化SDK

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-sdk.md

初始化脚本示例如下：

```APIDOC
````
<script type='text/javascript'>
  (function (w, d, t, s, n) {
    w[n] = w[n] || function () { (w[n].q = w[n].q || []).push(arguments); };
    var a, x = d.getElementsByTagName(t)[0];
    if (d.getElementById(n)) {return;}
    a = document.createElement(t); a.id = n; a.type = 'text/javascript'; a.async = true; a.src = s;
    x.parentNode.insertBefore(a, x);
  })(window, document, 'script', 'https://www.jinshuju.com/sdk.js?appid=<your_sdk_appid>&v=1.0.0', 'gdsdk');
<script>
````
```

--------------------------------

### Get Form Status

Source: https://github.com/jinshuju/jinshuju-api-docs/blob/master/enterprise-api.md

Retrieve the current status of a form, including whether it is open, its permission level, and the number of entries. Requires the `forms` scope.

```HTTP
GET https://api.jinshuju.com/v4/forms/RygpW3/status?access_token=...
```