开放数据协议(OData)定义了一套构建和使用RESTful API的最佳实践。Minitab Connect OData 4 版 API 使得从任何外部来源连接变得前所未有的简单。目前数据为只读。你不能通过这个API对数据进行任何更新。
注意

单个用户每秒最多只能发出20次API请求,每分钟最多1000次。所有Connect订阅用户每秒最多只能发200次请求,每分钟最多10,000次。

基础网址

无论你具体请求哪个 API 的请求,基础 URL 都是一样的。要确定你的基础网址应该是什么,复制你用来登录Minitab Connect的URL,并添加 /api/odata_v4/。例如,如果你用 https://connect.minitab.com 访问Minitab Connect,那么所有OData API请求的基础URL是: https://connect.minitab.com/api/odata_v4/

认证方法

通知系统请求应以与指定用户相同的权限处理。认证由API密钥表示。API密钥是一串独特的字符,用于访问工具中的某个功能。要创建 API 密钥,请在右上角打开 用户 菜单并选择 账户设置。有关更多信息,请转到 生成一个 API 令牌

有三种不同的认证方法。

查询字符串 API 密钥
一个名为“apikey”的GET或POST参数,包含连接账户设置页面生成的令牌。例如,https://connect.minitab.com/api/odata_v4/?apikey=[ apikey],你用实际的API密钥替换'apikey'。
头部API密钥
一个名为“X-Api-Key”的HTTP头,包含连接账户设置页面生成的令牌。
基础网页认证
你的用户名就是你的Connect用户名或电子邮件地址。密码是连接账户设置页面生成的令牌。

端点

基础端点 - https://connect.minitab.com/api/odata_v4/
返回一个实体集列表,这些实体集是用户可访问的表和视图。
注意

连接所有非 A-Z、a-z、0-9、非 A-Z、非 AC(连字符)和 _(下划线)字符,这些字符来自实体(记录)、实体集(表和视图)以及属性。Connect 会为表加上“_t”,视图为“_v”,并为实体和企业集名称添加 ID,以确保唯一名称。例如:

  • TableName_t38
  • ViewName_v2

元数据端点 - https://connect.minitab.com/api/odata_v4/$metadata
返回所有实体、实体集和属性的XML数据定义。
实体集端点 - https://connect.minitab.com/api/odata_v4/[EntitySet]
返回实体集(表或视图)中的记录。默认情况下,顺序与Base或View上的顺序一致。将“EntitySet”替换为对应的Minitab Connect表或视图名称。你可以返回基础端点所有表和视图的名称。
实体集端点目前仅支持三个功能:
$count - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$count
返回记录数量
$top - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$top=[数字]
返回实体集合中的“编号”记录。默认和最高记录均为5000条。你可以结合$skip来翻阅所有记录。
$skip - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$skip=[number]
跳过“数字”记录。你可以和$top结合,翻阅所有记录。
注意

实体集端点目前不支持 $filter、$select、$orderby 或 $expand 函数。你也可以使用 准备 工具在 Minitab Connect 中创建保存的表格视图,实现同样的$filter、 $select 和 $orderby效果。

实体端点 - https://connect.minitab.com/api/odata_v4/[EntitySet]([sys_id])/

返回一个实体(一条记录),由指定的“EntitySet”中标注为“sys_id”。