数据API支持用户无需编程创建符合HTTP GET/POST标准的API,供外部系统调用。

1. 数据API入口

进入菜单“数据探索”->“数据API”,进入“数据API”管理页面,点击页面右上方【创建】按钮开始创建数据API。用户也可在此管理页面对自己创建的API进行分组、启停、编辑、Token管理、查看详情、删除等操作。

数据API入口.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。