API 请求概述
每个端点都有一组特定的属性列表，这些属性包含一些值，有些是共享的，有些是唯一的，可以使用 API 版本 3 的搜索请求进行搜索。要接收端点的属性列表，只需编写一个简单的 API 版本 3 请求。API 版本 3 对端点属性的请求只需三个基本信息：基础网址、端点和 API 密钥。
注意
单个用户每秒最多只能发出20次API请求，每分钟最多1000次。所有Connect订阅用户每秒最多只能发200次请求，每分钟最多10,000次。
- 基础网址
- 无论具体的 API 请求是什么，基础 URL 都是相同的。要确定你的基础URL应该是什么，只需复制你用来登录 Minitab Connect的URL。例如，如果你用
https://connect.minitab.com访问 Minitab Connect，那么所有 API 请求的基础 URL 是：https://connect.minitab.com/api/3/。 - 终点
- 表示请求意图交互的对象或对象集合。在上述示例中，“示例 API 请求”中的端点是“源”。这将限制 API 请求只能针对专门设计用于操作“源”数据对象的动作。
例如，https 中的端点 ：connect.minitab.com/Source/?apikey=12478781287471824&action=search&arg=[{“name”：“Campaigns”}] 是“Source”。这将限制 API 请求只能用于专门设计操作“源”数据对象的操作。
- 端点 GUID
- 端点GUID是一个唯一标识符，代表该内 Minitab Connect的特定数据对象。GUID 由唯一的字符串组成，有时也被称为“密钥”。要在 中找到 GUID Minitab Connect，打开 编辑 目标对象的模态。并非所有API请求都需要端点GUID。例如，执行搜索动作的 API 请求省略了端点 GUID。
- API密钥
- API 请求的这一部分通知系统，请求应以与指定用户相同的权限处理。这始终由GUID表示。API密钥是与特定用户 Minitab Connect关联的唯一字符串。要找到你的GUID，首先登录系统。接下来，打开 用户 按钮
右上角选择 账户设置。列出了可用的API密钥列表，并可生成新的密钥。（在本例中，使用虚拟API密钥用于安全） - 认证
- 通知系统请求应以与指定用户相同的权限处理。认证由API密钥表示。API密钥是一串独特的字符，用于访问工具中的某个功能。要创建 API 密钥，请打开按钮 用户 右上角选择 账户设置。有关详细信息，请转到 生成一个 API 令牌。
- 操作
- 指定对指定端点应采取的操作。动作通常分为以下几类：
- 收官者：获取器动作用于从系统中提取数据。每个端点都有一组独特的获取子。使用获取子的正确格式是：
action=，其中被目标获取子的名称替换。 - 赛特犬：设置器动作用于导入系统数据以及设置或更改数据对象的属性。每个端点都有一组独特的二传者。使用设定器时，正确的格式是：
action=&arg=，其中被替换为目标设定者的名称，是待设定的值。 - 行动：动作用于数据对象中不符合获取者特征的进程、特征或命令。一个动作的例子是向表添加字段。每个动作都有不同的要求。例如，有些动作不需要参数，格式与获取器相同。其他动作要求参数格式类似二传者。
- 搜索：搜索用于从满足特定参数集合的端点获取数据。搜索可以有无限数量的搜索词，并且以数组形式进行。例如：
action=search&args=[{“fname”：“John”，“lname”：“Smith”}]只返回 [“fname”（名字）是“John”，且“lname”（姓氏）是“Smith”的记录。你可以使用任意数量的搜索词，只要符合key：value结构并且用逗号分隔即可。注意
在将值添加到 API 搜索请求时，文本字符串必须置于引号内。
你可以发起包含多个动作的 API 请求。为此，用和号（'&'）分隔每个动作。例如，你需要更改ID为15的用户的名字、中间名和姓氏。请求内容如下：
https://connect.minitab.com/api/3/User/15?apikey=45a3d34982e&action0=setFName&arg0=John&action1=setMName&arg1=D&action2=setLName&arg2=Smith该请求将用户ID为15的用户设置名字为“John”，中间名为“D”，姓氏为“Smith”。注意
当单个API请求中使用多个动作时，动作必须递增。第一个动作和参数可以加上0或1。每增加一个动作分组，必须增加1倍。
- 收官者：获取器动作用于从系统中提取数据。每个端点都有一组独特的获取子。使用获取子的正确格式是：
API 请求返回该端点的所有操作
在任何时候都可以发出 API 请求，返回一个特定端点可用的所有操作列表。请求如下：
https://connect.minitab.com/api/3/[endpoint]/？apikey=[apikey]
用特定的端点替换该 端点 ，用真正的API密钥替换 apikey 。会返回一个 JSON 对象，包含该端点的所有操作以及所有属性。
当前终点与描述
在任何时候，你都可以发起 API 请求，返回所有端点的列表。请求如下：
https://connect.minitab.com/api/3/?apikey=[apikey]
apikey 。将返回一个包含所有可用端点列表的 JSON 对象。目前可用的端点如下：
- AutoImportConf
- 创建、读取并交互自动导入配置（定义为 Minitab Connect内部的自动导入向导）。
- 斑点
- 存储和检索以“file”字段类型存储的文件 Minitab Connect。
- 商业规则
- 创建、查看并与业务规则互动。
- 商业规则集团
- 创建、查看并与业务规则组交互。
- 商业规则触发器
- 允许 API 请求创建新的业务规则触发器，或读取、修改、删除或执行现有的业务规则触发器。
- 连接
- 允许 API 请求创建新连接，或读取、修改或删除现有连接。
- 客户
- 允许 API 请求创建新客户，或读取、修改或删除现有客户。
- 控制台
- 允许 API 请求创建新的仪表盘，或读取、修改或删除现有仪表盘。
- DashboardElement
- 允许 API 请求创建新的仪表盘元素。同时允许读取、修改或删除现有仪表盘元素。
- 错误日志
- 阅读错误日志。
- 场地格式
- 允许API请求与系统定义的字段格式交互。例如，文本字段可以有URL格式。
- 场类型
- 允许 API 请求创建新的自定义字段，或读取、修改或删除现有的自定义字段。
- 字段类型触发器
- 允许 API 请求创建新的字段类型触发器，或读取、修改、删除或执行现有字段类型触发器。
- FileImporterLocations
- 创建新文件，或者读取/交互文件导入调度器使用的位置。
- 流程
- 允许与流程互动。你可以创建、修改和删除流程。你可以通过版本3的API获取流数据并手动执行流程。
- 形式
- 创建新表单，修改或删除现有表单。你可以通过API获取表单数据。
- FormElement
- 允许 API 请求创建新的表单元素。同时允许读取、修改或删除现有表单元素。
- 工作
- 创造新工作岗位。
- KVStore
- 用于键值存储。端点允许创建、修改、读取或删除键值对。
- 混搭
- 用于系统内部使用。
- 表演日志
- 阅读性能日志。
- 插件
- 允许 API 请求修改现有插件并读取插件数据（包括列出可用插件）。
- 个人资料日志
- 阅读画像师的历史。
- SavedAPI
- 控制 保存导出。
- 来源
- 与源（表格）互动。可以创建新的表格。现有的表格可以被修改、读取或删除。
- 来源图
- 创建、阅读、修改或删除图表。
- 来源有条件
- 创建、修改或删除表格的条件格式。
- 来源连接
- 读取或修改绑定在表上的源连接。
- SourceExportOption
- 创建、读取并交互存储的导出连接器设置。
- SourceField
- 创建、修改或删除表格字段。
- 源接口
- 与表格数据互动。插入、更新、删除、导出、读取数据行。
- 来源加入
- 使用连接件。这对应于创建/编辑混搭表时的“添加加入”对话框。那里创建的每个项目都有一个带有唯一ID的“连接”。
- 来源注释
- 创建、阅读、修改或删除表格笔记。
- 来源简介
- 创建、阅读或与画像师创建的个人资料互动。
- 来源统计日志
- 阅读表格的历史统计数据（规模、记录等）。
- 源模板
- 创建、阅读或修改表格模板。
- 来源类型
- 与文件夹互动。可以创建新的文件夹。现有文件夹可以被修改、读取或删除。
- SourceView
- 与视角互动。可以创建新的视图。现有视图可以被修改、读取或删除。
- 统计数据
- 创建、阅读、修改或删除客户统计数据。
- 主题
- 创建、阅读、修改或删除主题。（表单、仪表盘、界面）。
- 树木信息
- 由树导入者内部使用。仅限系统使用。
- 用户
- 与用户互动。允许 API 请求创建、读取、修改或删除用户。
- 用户类型
- 创建、读取、修改或删除系统治理用户组。
- 版本控制
- 创建或修改 HBase 表格的版本控制设置。该端点还包含将数据推送到HBase和从HBase拉取数据的方法。
- 工作区
- 与集合（以前称为工作区）交互。允许API请求创建、读取、修改或删除集合。
- 工作空间元素
- 在集合中创建、读取、修改或删除元素，如表格、表单和仪表盘。
