1. 概述
2. 接口文档
已经发布的 API 接口说明如下：
请求说明：
| 请求域名 | 发布 API 中使用的 FineDataLink 服务器地址 例如：http://192.168.5.175:8068/webroot 若需要自定义Web容器访问路径，可联系技术支持获取方案，技术支持联系方式：前往「服务」，选择「在线支持」、电话「400-811-8890」。 | ||||||
|---|---|---|---|---|---|---|---|
| 请求地址 | 例如：http://localhost:8068/webroot/service/publish/a73a7179-20b8-40db-a4e5-15f10d75ff67/wendang 注：可直接在发布界面复制API请求地址。 API访问路径：「请求域名」+「应用路径前缀」+「应用ID」+「APIPath」
请求地址获取方式请参见：调用API | ||||||
| 请求方式 | GET |
GET Query Params请求参数：
| 参数 | 类型 | 参数必填按钮 | 说明 | 备注 |
|---|---|---|---|---|
| pageNum | 数值 | 默认开启 | 分页参数 pageNum 为页数，数值可自定义 | 若不开启 分页查询 按钮，Body 中无需填入这些参数 |
| pageSize | 数值 | 默认开启 | 每页数据条数，数值可自定义 注：每页数据条数单次调用最大限制为100000 | |
| returnTotalNum | 布尔 | 默认关闭（可开启） | 是否返回总的数据条数 | |
| params | 可以为字符串、数值、布尔值 | 否 | 自定义参数 如果在发布API时设置了自定义参数，但是请求中未传此参数，则返回报错 | - |
请求示例：
注：此处的 area 为 发布API 中设置的自定义参数。
返回值参数：
| 名称 | 类型 | 描述 | 备注 |
|---|---|---|---|
| output | object | 返回用户使用接口取出的数据 | - |
| code | int | 错误码；详情请参见本文第四章内容 | - |
| message | string | success，则返回成功 失败时具体原因会在Message中体现；详情请参见本文第四章内容 | - |
totalNum | int | 返回取出数据的总数据条数 | 若不开启 分页查询 按钮，调用 API 后返回数据中没有这些参数 |
| pageSize | int | 返回取出数据的每页数据条数 | |
| pageNum | int | 数据页数，即从第几页开始取 | |
| rowCount | int | 当前页数包含的数据条数 与 pageNum 页数有关。比如一共12条数据，传入的pageNum是2，pageSize是10。实际会查询第二页的数据，实际返回2 |
响应值示例：
3. 测试接口
3.1 获取API地址
首先在API列表界面选择需要使用的API，然后在已授权应用处复制路径，获取到 API 完整路径地址，例如：http://localhost:8068/webroot/service/publish/a73a7179-20b8-40db-a4e5-15f10d75ff67/wendang，如下图所示：
3.2 获取 API 鉴权
若用户使用了鉴权，则需要在「应用」中复制 APPCode，如下图所示：
注：如果开启了黑白名单，需要保证使用 API 的环境与发布 API 环境之间信息能互通。
3.3 设置 API 基本信息
使用任意取数软件，选择GET请求方式，输入复制的API链接，选择「Authorization」，勾选认证类型为「API Key」，输入Key：Authorization，value ：本文 3.2 节复制的值，选择 Add to 为 Header，如下图所示：如下图所示：
注1：复制的链接默认为IP:端口/webroot 路径，如果用户的FineDataLink做过Tomcat下通过IP直接访问系统，则需要给复制的url去掉webroot。
注2：参数值格式为：APPCode+空格+APPCode值，此处的 APPCode 为示例。
然后选择 Params ，输入参数，如下图所示：
示例取出「华北」的数据，因此自定义参数货主地区的 value 直接写成华北，将 pageSize 设置为 300，也就是每页数据限制为 300 条，取出第一页数据。
点击 send 后返回值如下图所示：
4. 接口响应码说明
用户在使用API发布的数据时，可以根据 Message 字段判断 API 响应成功与否。
Message 为 success，则返回成功。如下图所示：
否则当返回失败时，会返回失败状态码。
调用返回值说明详情参见：数据服务错误代码表
上一篇：数据查询API-参数为空查询全部
