“数据API”支持用户无需编程创建符合HTTP GET/POST标准的API，包括从数据视图一键创建和自定义两种方式。下图数据API管理管理页面支持数据API创建、数据API分组、启停、编辑、Token（Key）管理、查看调用详情、删除等操作。

image.png

1. 从视图创建API

  • 点击上图【创建】->【从视图创建】，选择一个数据视图，填写API名称和分类，点击【保存】按钮自动生成一个Get类型的数据API，调用时返回该数据视图所有字段信息和数据。

image.pngimage.png

2. 自定义数据API

创建数据API.png

2.1 定义API对应数据

  • 点击【创建】按钮，选择“自定义”，跳转到探索分析页面，通过Web工作表定义API对应数据，操作详见“开始数据探索”章节。

    2.2 设置API参数

  • Web工作表下方设置API名称、分类（目录）、请求方式（GET或POST）

  • 设置API参数：选择字段（同一字段可选择多次，组合不同比较符）、自定义参数名（可选，不填则用字段名称）、选择比较符号、选择或输入参数值（可选，默认留空，非空则表示API调用时该参数必须传递参数值中指定的值，否则返回错误代码）。

  • 选择启用和对应Key（Token），Key不存在则需要配置，见2.4章节。

    2.3 保存API配置

  • 完成上述步骤，点击探索分析页面右上方【保存】按钮，在API管理列表可见新创建的API。

    2.4 Key（Token）配置

  • 在数据API管理页面，点击右上方【管理Key】按钮，进入Key（Token）管理页面，用户在此管理页面对自己创建的Key（Token）进行创建、编辑、删除操作。点击页面右上方【创建】按钮，弹出框中填入Key名称和描述（可选）即可。注意Key（Token）在实际调用中将生成加密串。

    2.5 获取API调用URL

  • 在数据API管理列表，点击某指定API右侧的【详情】按钮，弹出页面中显示该API每个Key对应的URL和调用次数等信息，点击右侧【复制URL】按钮即可获取API调用URL。