配置用于构建 FastReport 在线设计器的 API（上）
配置用于构建 FastReport 在线设计器的 API（下）
FastReport 在线设计器生成器现在可以使用 API 生成设计器。以前，用户必须在 FastReport Online Designer Builder 中手动构建。您可以下载结果或通过邮件接收结果。现在，如果产品版本发生变化，您可以自动更新 FastReport Online Designer。为此，您需要创建与 API 配合使用的功能，并在服务器上部署设计器构建。以使用 API 为例，您可以每天请求一次产品版本，如果版本发生变化，则自动请求构建。之后，托管更新后的设计器。
API 密钥
用户使用 API 密钥进行身份验证，您可以在 FastReport Online Designer Builder 中创建该密钥。要创建密钥，您需要
- 登录您的账户；
- 转到新 API 密钥菜单项；
- 点击右下角的按钮或红色铭文。
之后，就会生成一个新的 API 密钥。您可以点击密钥进行复制，并将其用于 API 的身份验证。
构建请求
要请求构建，请在以下地址发出 POST 请求：
https://dsg2014.fast-report.com:3000/builderAPI/build
请求正文必须至少包含您的 API 密钥。如果未指定参数，将使用其默认值！
最小请求示例：
{
"APIKey": "Your API key"
}
API 接受的构建参数如下所述。
| 参数 | |
| 参数 | 说明 |
| themes | 构建主题。 |
| 数据类型：字符串 | |
| 请参阅主题表中的值。 | |
| components | 将包含在构建中的组件。 |
| 数据类型：数组 | |
| 请参阅组件表中的值。 | |
| bands | 将包含在构建中的频段。 |
| 数据类型：数组 | |
| 请参阅频段表中的值。 | |
| controls | 包含在构建中的对话框控件。 |
| 数据类型：数组 | |
| 请参阅控件表中的值。 | |
| plugins | 要包含在构建过程中的插件。 |
| 数据类型：数组 | |
| 查看插件表中的值。 | |
| customization | 包含在构建中的控制面板。 |
| 数据类型：数组 | |
| 请参阅面板表中的值。 | |
| config | 构建配置。 |
| 数据类型：对象 | |
| 请参见设置表中的对象结构。 | |
| 主题 | |
| 值 | 说明 |
| none | 无主题 |
| classic | 使用经典主题 |
| mini | 使用极简主题 |
| 组件 | |
| 值 | 说明 |
| TextObject | 文本组件 |
| PictureObject | 图片组件 |
| ShapeObject | 形状组件 |
| PolygonObject | 多边形组件 |
| PolyLineObject | 多边线组件 |
| LineObject | 线条组件 |
| SubreportObject | 子报告组件 |
| TableObject | 表格组件 |
| MatrixObject | 矩阵组件 |
| AdvMatrixObject | 高级矩阵组件 |
| BarcodeObject | 条形码组件 |
| RichObject | 富文本组件 |
| CheckBoxObject | 复选框组件 |
| CellularTextObject | 单元文本组件 |
| LinearGauge | 线性仪表控件 |
| SimpleGauge | 简单仪表组件 |
| RadialGauge | 径向仪表组件 |
| SimpleProgressGauge | 简单进度表组件 |
| HtmlObject | HTML 组件 |
| SVGObject | SVG 组件 |
| ContainerObject | 容器组件 |
| DigitalSignatureObject | 数字签名组件 |
| MapObject | 地图组件 |
| 频段 | |
| 值 | 说明 |
| ReportTitleBand | 报告标题 |
| ReportSummaryBand | 报告摘要 |
| PageHeaderBand | 页眉 |
| PageFooterBand | 页脚 |
| ColumnHeaderBand | 栏头 |
| ColumnFooterBand | 栏脚 |
| DataHeaderBand | 数据标题 |
| DataBand | 数据 |
| DataFooterBand | 数据页脚 |
| GroupHeaderBand | 组标题 |
| GroupFooterBand | 组页脚 |
| ChildBand | 子频段 |
| OverlayBand | 覆盖频段 |
| 控件 | |
| 值 | 说明 |
| ButtonControl | 按钮 |
| CheckBoxControl | 复选框 |
| CheckedListBoxControl | 复选列表 |
| ComboBoxControl | 带组合框的文本 |
| DateTimePickerControl | 日期时间选择器 |
| LabelControl | 标签 |
| ListBoxControl | 列表 |
| MonthCalendarControl | 日历 |
| RadioButtonControl | 单选按钮 |
| TextBoxControl | 文本框 |
| 插件 | |
| 值 | 说明 |
| CODE | 带代码的页面 |
| GUIDES | 指导线 |
| POSITION_BLOCK | 部件移动时的位置 |
| RULER | 标尺 |
| BAND_HORZ_RESIZER | 频段水平调整 |
| HOTKEY | 热键 |
| CONTEXT_MENU | 上下文菜单 |
| DBLCLICK | 双击 |
| 面板 | |
| 值 | 描述 |
| Properties | 属性面板 |
| Events | 事件面板 |
| ReportTree | 复制树面板 |
| Data | 数据面板 |
| Preview | 页面预览面板 |
配置用于构建 FastReport 在线设计器的 API（上）
配置用于构建 FastReport 在线设计器的 API（下）
渝公网安备50010702505508