Server API Tool（Server API 工具）
使用 Server API 工具与 Server API（v1、v2 和 v3）交互，无需编写复杂的工作流。要了解有关 Server API 访问、身份验证、端点、参数和版本的信息，请访问 Server API 概述 页面。
提示
此工具不会随 Alteryx Designer 自动安装。要使用此工具，请从 Alteryx Marketplace 下载。
Server API 工具 2021.4 版及更高版本的 Designer 和 Server 兼容。请注意，根据您的 Server 版本，该工具的某些功能可能会受到限制。
与 Alteryx Multi-threaded Processing (AMP) 和原始引擎兼容。
Server API 工具目前不支持数据连接管理器的仅 DCM 模式。
Server API 工具要求您在计算机上安装以下包：
oauthlibrequests_oauthlib
如果您没有安装这些包……
将 Server API 工具添加到工作流画布中并运行该工作流。该工具会生成错误来提醒您存在任何缺失的包。
找到工作流结果窗口，然后选择全选选项卡（或文件选项卡，以缩小项目列表范围）。
找到并选择内容如下的消息：“Run this linked workflow as Admin to install missing packages.（以管理员身份运行此关联工作流，以安装缺失的包。）”这将打开一个带有 Python 工具并且已预先配置为安装必需包的新工作流。运行该工作流以执行安装。请注意，您需要以管理员身份运行此安装工作流。
或者，您也可以重复上述操作，通过 Python 工具安装包。请参阅 其它包安装，了解如何安装包。
Server API 工具有 6 个锚点：
输入锚点（两个均为可选锚点）：
A （Authorization（授权）） 输入锚点：如果您选择使用工具配置中字段的值，请使用此锚点提供您的授权信息。选择包含您的 API 基 URL 的字段和包含您的授权信息的另一个字段（通常是上游 Server API 工具 A 输出中的 Authorization（授权）字段）。请注意，授权信息是您最初进行身份验证时 OAuth2.0 生成的 Bearer 前缀和 access_token 的组合。如需了解详情，请参阅 Server API 配置和授权。
D（Data（数据））输入锚点：如果您选择使用工具配置中字段的值，请使用此锚点为端点提供参数。请注意，某些端点有必需参数。
输出锚点：
A (authToken) 输出锚点：此锚点将输出您的身份验证信息，以便在您要进行多次调用时随时使用。将此输出锚点连接到另一个 Server API 工具的 A 输入锚点，重新对下游的另一个 API 调用进行无缝身份验证。
S（Success（成功））输出锚点：此锚点将输出响应代码为 200 的任何 API 调用。我们会将 API 响应向下解析一级*，并在此处输出字段。如果我们无法解析响应，Extracted（已提取的）输出字段将包含一条说明原因的消息，并且我们会在 DownloadData 和 BinaryData 输出字段中提供原始数据。
F（Fail（失败））输出锚点：此锚点将输出未收到响应代码 200 的任何 API 调用。
L（Logs（日志））输出锚点：此锚点将输出 API 调用产生的日志信息。
为了举例说明，我们对此响应进行了简化。原始 JSON 示例显示了一个典型的 JSON 响应，随后是通过 Server API 工具得到的相同响应的示例。
[
{
"id": "12345",
"dateCreated": "2023-05-02T16:50:05.829Z",
"runCount": 0,
"versions": [
{
"versionId": "67890",
"versionNumber": 1,
"dateCreated": "2023-05-02T16:50:05.829Z",
"details": {
"isAmp": false,
"fileName": "test.yxmd"
}
}
]
},
{
"id": "54321",
"dateCreated": "2023-05-03T10:50:48.681Z",
"runCount": 0,
"versions": [
{
"versionId": "09876",
"versionNumber": 1,
"dateCreated": "2023-05-03T10:50:48.681Z",
"details": {
"isAmp": false,
"fileName": "test2.yxmd"
}
}
]
}
]
通过 Server API 工具得到的相同响应格式如下。请注意，在 Server API 工具的响应中，版本项将被合并到一个列/字段中。
ID | dateCreated | runCount | versions |
|---|---|---|---|
12345 | 2023-05-02T16:50:05.829Z | 0 | [{'versionId': '67890', 'versionNumber': 1, 'dateCreated': '2023-05-02T16:50:05.829Z', 'details': {'isAmp': False, 'fileName': 'test.yxmd'}}] |
54321 | 2023-05-03T10:50:48.681Z | 0 | [{'versionId': '09876', 'versionNumber': 1, 'dateCreated': '2023-05-03T10:50:48.681Z', 'details': {'isAmp': False, 'fileName': 'test2.yxmd'}}] |
使用工具配置窗口配置执行 API 调用所必需的任何字段。
使用身份验证部分提供必需的身份验证信息。如需了解详情，请参阅 API 密钥和 API 访问权限，以及 Server API 配置和授权。
使用字段中的值：默认关闭。打开此切换开关可指定存储基 URL 和授权令牌（API 验证序号和 API 密钥）信息的传入字段。通过选择基 URL 字段和选择授权字段下拉列表选择字段。如果您使用此选项，我们将仅使用您提供的第一条记录作为基 URL 和身份验证令牌。
您还可以通过工具配置窗口直接提供您的身份验证信息。请注意，如果您打开上述使用字段中的值切换开关，这些字段将隐藏。
基 URL：提供 Server API 的基 URL。您可以通过 Server UI 配置 对此进行配置。
API 验证序号：输入您的 API 验证序号。
API 密钥：输入您的 API 密钥。
使用 API 配置部分选择您的方法，选择端点，并为 API 调用提供参数。
选择方法：使用此下拉列表选择您的 API 方法。从以下项目中选择：
GET：通过 GET 方法，您可以读取或查看资源。例如，通过用户端点上的 GET 方法，您可以读取或查看用户列表。
POST：通过 POST 方法，您可以创建资源。例如，通过用户端点上的 POST 方法，您可以创建新用户。
PUT：通过 PUT 方法，您可以更新资源。具体来说，PUT 方法将替换现有资源。例如，通过用户端点上的 PUT 方法，您可以将现有用户详细信息替换为您提供的用户信息来进行更新。
DELETE：通过 DELETE 方法，您可以删除资源。例如，通过用户端点上的 DELETE 方法，您可以删除现有用户。当您选择 DELETE 方法时，系统将显示确认 DELETE 方法开关。您必须启用此开关才能成功执行删除。
端点：使用此下拉列表选择您的端点。选项因您选择的方法而异。如需详细了解有关 Server API 端点和参数的信息，请参阅 API 端点和参数、访问 Server API V3 和 Server V3 API 对象。
使用传入字段作为参数*：默认关闭。打开此切换开关可指定要用作参数的传入字段。接下来，使用可用的下拉列表指定包含参数信息的字段。
输入参数值*：如果您选择不使用传入字段作为参数，则可直接通过所提供的字段输入参数。
端点参数
请注意，可用参数取决于端点。此外，某些端点有必需参数，另一些端点则没有。如需详细了解有关 Server API 端点和参数的信息，请参阅 API 端点和参数、访问 Server API V3 和 Server V3 API 对象。
实际数据：如果选择手动输入实际数据，您可在此处以 JSON 格式直接输入。或者，使用上述使用传入字段作为参数切换开关来指定包含实际数据的传入字段。
架构示例：如适用，架构示例将填充 API 实际数据的正确结构。您可以选择在实际数据中使用架构按钮，将通用文本复制到实际数据选项卡中并对其进行修改。