数据开放服务API

基于DMP中已创建的数据集，添加自定义参数，形成数据开放服务的API，供页面开发时调用。

特别注意：数据开放服务不支持多数据集的查询，如定制页面上有多数据集查询的需求，需要先在dmp平台内制作组合数据集。

在平台中添加过程如下：

1、注册API

菜单切换到“开发管理-数据开放API”，进入开放API管理页面，右上角的新增入口添加一个API；

进入添加界面，整个添加页面分为5大区域：API基本信息填写区、数据集及字段选择区、API查询语句编辑区、API及其参数预览区、查询数据预览区。

1.1 API基本信息填写区

数据API名称：必填，且不能包含中文字符； 备注：选填；

1.2 数据集及字段选择区

数据集列表中，可以选择当前系统中的任意数据集，选中数据集后，右侧自动展开数据集下所有的字段；

点击数据集后的插入按钮，可将数据集名称插入右侧SQL编辑器中，在查询时作为表名使用；

单击数据集字段，可将字段插入右侧SQL编辑器中，也可以点击插入按钮，快捷插入所有字段；

1.3 API查询语句编辑区

API查询语句使用的SQL语法，为标准的MySQL语法，但有3点区别：

• 字段名需要用中括号 [] 圈起，否则字段名无效；
• 表名需要用方括号 {} 圈起，否则表名无效；

查询语句中插入的参数使用{:xxx}的格式， 如图上示例的参数，min_money, max_money实现累计净认购金额的区间过滤, page_size和offset, 实现数据分页，语法如图：

测试运行语句时，可以为添加的自定义参数赋值，实现参数调试的操作；

1.4 API及其参数预览区

SQL测试运行成功后，可查看API中的参数；

1.5 查询数据预览区

SQL测试运行成功后，可预览当前参数条件下查询到的数据；

保存后，即可完成API注册过程。

2、API信息查看

在开放服务API管理界面，可以查看已添加API的调用参数，及其详细信息。

自定义参数位于biz_params中：

POST /api/open_data/dataset_data
Content-Type: application/json
data: 
{
  "api": "_demo",
  "biz_params": {
    "min_money": "0",
    "max_money": "100000",
     "page_size": "10",
      "offset": "0"   
  }
}