Skip to main content

license-portal.png 许可 API 工具

可使用“许可 API”工具通过易于使用的接口连接到 Alteryx Designer 许可门户 API。此工具可让您在整个组织和多个合同之间管理许可证。其功能包括激活离线许可证、监控使用情况，以及停用设备、用户和许可证。

提示

此工具不会随 Alteryx Designer 自动安装。要使用此工具，请从 Alteryx Marketplace 下载。

要求和兼容性说明

必需的包安装

许可 API 工具要求您在计算机上安装此 Python 包：

pip-system-certs

如果您尚未安装此包…

  1. 以管理员身份打开 Designer。为此，请右键点击 Designer 图标，并选择“以管理员身份运行”。

  2. 将许可 API 工具添加到工作流画布中并运行该工作流。该工具会生成错误来提醒您缺失任何包。

  3. 导航到工作流结果窗口，然后选择全选选项卡（或文件选项卡，以缩小项目列表范围）。

  4. 找到并选择以下内容的消息：“Run this linked workflow as Admin to install missing packages.（以管理员身份运行此关联工作流以安装缺失的包。）”这将打开一个带有 Python 工具并且已预先配置为安装必需包的新工作流。运行该工作流以执行安装。请注意，您需要以管理员身份运行此安装工作流。

或者，您也可以重复上述操作，通过 Python 工具安装包。请转到其他包安装，了解如何安装包。

工具组件

许可 API 工具有 6 个锚点：

  • 输入锚点（两个均为可选锚点）：

    • A（Authorization [授权]）输入锚点：如果您选择使用工具配置中字段的值，请使用此锚点提供您的授权信息。选择包含您的 API 基 URL、身份验证 URL 的字段，以及另一个包含您的授权信息的字段（通常是上游许可 API 工具 A 输出中的 access_token 字段）。请转到许可和下载门户 API，了解如何申请 API 访问令牌。

    • D（Data [数据]）输入锚点：如果您选择使用工具配置中字段的值，请使用此锚点为端点提供参数。请注意，某些端点有必需参数。

  • 输出锚点：

    • A (authToken) 输出锚点：此锚点将输出您的身份验证信息，以便在您要进行多次调用时随时使用。将此输出锚点连接到另一个许可 API 工具的 A 输入锚点，重新对下游的另一个 API 调用进行无缝身份验证。

    • S（Success [成功]）输出锚点：此锚点将输出响应代码为 200 的任何 API 调用。我们会完整解析 API 响应，并在此输出各字段。嵌套的 JSON 结构在字段名称中以句点 (.) 分隔，数组索引记录在以 .idx 结尾的字段中。您可以在 L（Logs [日志]）输出锚点中找到完整的 JSON 响应。如果我们无法解析响应，已提取输出字段将包含一条说明原因的消息，并且我们会在 DownloadData 和 BinaryData 输出字段中提供原始响应数据。

    • F（Fail [失败]）输出锚点：此锚点将输出响应代码不是 200 的任何 API 调用。

    • L（Logs [日志]）输出锚点：此锚点将输出 API 调用产生的日志信息。

响应示例

为了举例说明，我们对此响应进行了简化。原始 JSON 示例显示了一个典型的 JSON 响应，随后是通过许可 API 工具得到的相同响应示例。

原始 JSON 响应示例

{
	"data": [{
		"id": "Alteryx Designer (2022.3)",
		"name": "Alteryx Designer",
		"version": "2022.3",
		"description": "Alteryx Designer (2022.3)",
		"extendedDescription": "With the recent update to a new installer, at this time we will not release a new full version each time we release a patch. This means that If you haven't already installed the full 2022.3.1.395 release of Designer and you want to install it (and want the patch as well), you will need to first install the full release and then install the patch release separately. Be aware that this doesn’t apply to Server customers as the full Server 2022.3 version is being released alongside the Designer Patch 1 release. As a result, no patch installations are currently available for Server 2022.3. All changes that are contained in 2022.3 Patch 1 for Designer are included with the full Server 2022.3 release, available on January 25. Go to <a href=\"https://help.alteryx.com/release-notes/designer/designer-20223-release-notes\"target=\"_blank\">Release Notes</a> for more information.",
		"releaseDate": "2023-03-08T08:00:00.000+00:00"
	}, {
		"id": "Alteryx Designer (2021.1)",
		"name": "Alteryx Designer",
		"version": "2021.1",
		"description": "Alteryx Designer (2021.1)",
		"extendedDescription": "20.4 and newer versions include important Python changes that can cause workflow errors. If you use Data Connectors installed via Public Gallery <a href=\"https://help.alteryx.com/current/designer/upgrade-python\"target=\"_blank\">Click Here to Read More </a> before installing. <br><br> As of the 2021.2 release, Alteryx Intelligence Suite is not included in the Alteryx Designer installer and must be installed separately. Additionally, your version of Intelligence Suite must match your version of Designer.",
		"releaseDate": "2022-08-18T07:00:00.000+00:00"
	}],
	"msg": null
}

通过许可 API 工具得到的解析响应示例

ID

名称

版本

描述

extendedDescription

releaseDate

Alteryx Designer (2022.3)

Alteryx Designer

2022.3

Alteryx Designer (2022.3)

随着最近更新到新安装程序，目前我们在发布补丁时不会每次都发布新的完整版本。这意味着，如果您尚未安装 Designer 的 2022.3.1.395 完整版本，并且想要安装它（同时还需要补丁），则需要先安装完整版本，然后单独安装补丁版本。请注意，这不适用于 Server 客户，因为完整的 Server 2022.3 版本会与 Designer 补丁 1 同时发布。因此，目前没有适用于 Server 2022.3 的补丁安装包。Designer 2022.3 补丁 1 中的所有更改都包含在完整的 Server 2022.3 版本中，该版本将于 1 月 25 日发布。请转到 &lt;a href="https://help.alteryx.com/release-notes/designer/designer-20223-release-notes"target="_blank"&gt;Release Notes&lt;/a&gt;了解更多信息。

2023-03-08T08:00:00.000+00:00

Alteryx Designer (2021.1)

Alteryx Designer

2021.1

Alteryx Designer (2021.1)

20.4 及更新版本包含的重要 Python 更改可能会导致工作流出错。如果您使用通过公共 Gallery 安装的数据连接器，请在安装前&lt;a href="https://help.alteryx.com/current/designer/upgrade-python"target="_blank"&gt;点击此处了解详情&lt;/a&gt;。&lt;br&gt;&lt;br&gt; 自 2021.2 版本起，Alteryx Intelligence Suite 不再包含在 Alteryx Designer 安装程序中，必须单独安装。此外，您的 Intelligence Suite 版本必须与 Designer 的版本匹配。

2022-08-18T07:00:00.000+00:00

配置工具

使用工具的“配置”窗口来配置执行 API 调用所需的各个字段。

身份验证

使用身份验证部分提供必需的身份验证信息。请转到许可和下载门户 API 了解相关信息。

  • 使用字段中的值：默认关闭。打开此切换开关，以指定存储您的基 URL、身份验证 URL 和访问令牌信息的传入字段。通过选择基 URL 字段、选择身份验证 URL 字段和选择访问令牌字段下拉列表来选择字段。如果您使用此选项，我们只会使用提供的第一条记录。

您还可以通过工具配置窗口直接提供您的身份验证信息。如果您打开上述使用字段中的值切换开关，这些字段将被隐藏。

  • 基 URL：提供许可门户的基 URL。

  • 身份验证 URL：提供许可门户的身份验证 URL。

  • 刷新令牌：输入您的刷新令牌。此令牌用于获取访问令牌。

API 配置

使用 API 配置部分选择您的方法，选择端点，并为 API 调用提供参数。

  • 选择方法：使用此下拉列表选择您的 API 方法。从以下项目中选择：

    • GET：通过 GET 方法，您可以读取或查看资源。例如，在 Device（设备）端点上使用 GET 方法，您可以读取或查看设备列表。

    • POST：通过 POST 方法，您可以创建资源。例如，在Device（设备）端点上使用 POST 方法，您可以激活离线许可文件。

    • PATCH：PATCH 方法可用于更新资源。具体而言，PATCH 方法取代了现有资源的一部分。例如，在 Device（设备）端点上使用 PATCH 方法，可以从设备中移除许可密钥，但不会更改整个设备对象。

    • DELETE：通过 DELETE 方法，您可以删除资源。例如，在 Device（设备）端点上使用 DELETE 方法，您可以删除现有设备。当您选择 DELETE 方法时，会显示“确认 DELETE 方法”开关。您必须启用此开关才能成功执行删除。

  • 端点：使用此下拉列表选择您的端点。选项因您选择的方法而异。如需详细了解许可 API 端点和参数，请转到许可 API 文档。

  • 使用传入字段作为参数*：默认处于关闭状态。打开此切换开关可指定要用作参数的传入字段。接下来，使用可用的下拉列表指定包含参数信息的字段。

  • 输入参数值*：如果您选择不使用传入字段作为参数，可以直接在提供的字段中输入参数。

    *端点参数

    请注意，可用参数取决于端点。此外，某些端点有必需参数，而其他端点则无需参数。如需详细了解许可 API 端点和参数，请转到许可 API 文档。

  • 实际数据：如果选择手动输入实际数据，您可在此处以 JSON 格式直接输入。或者，使用上述使用传入字段作为参数切换开关，指定包含实际数据的传入字段。

  • 架构示例：如适用，架构示例将填充 API 实际数据的正确结构。您可以选择在实际数据中使用架构按钮，将通用文本复制到“实际数据”选项卡中并进行修改。

本节内容如下: