如何使用 Postman
您可以使用 Postman 测试 Server API V3。
先决条件:
您必须已安装 Postman。Postman 的网址为 go.postman.co/home 。
您必须具有 API 验证序号和 API 密钥才能在 Postman 中测试 Server API。如需了解详情,请前往 用户角色和权限 帮助页。
将 API 添加到 Postman
要测试 Server API,请将其导入 Postman。
首先,您需要获取用于导入 Server API V3 的链接。要查找此链接,请前往 Server UI,选择右上角的问号图标,然后选择 API 文档 。这将打开 API V3 Swagger 页面。
请记下您在 Swagger 页面上找到的 API 文档的地址。
在 Postman 中,找到 Collections(集合) ,然后选择 Import(导入) 。
选择 Link(链接) 并输入您在 第 2 步 中记下的 Server API URL,然后选择 Continue(继续) 。
现在,您可以在 Collections(集合) 选项卡下看到 Alteryx Server API V3。
设置授权
为了能够发送请求,您必须在 Postman 中设置授权。
找到 Collections(集合) ,并选择 Alteryx Server API V3 。
在 Auth(身份验证) 选项卡中,为 Type(类型)选择 OAuth 2.0 。
按如下方式设置 Current Token(当前令牌) :
在 Configure New Token(配置新令牌) 部分中,进行以下设置:
(可选)输入 Token Name(令牌名称) 。
在 Grant Type(授权类型) 中,选择 Client Credentials(客户端凭证) 。
在 Access Token URL(访问令牌 URL) 中,输入身份验证服务器的端点。要查找端点,请进入 Swagger 并搜索 令牌 URL 。如需了解详情,请访问 API 配置和授权 帮助页面上的 如何进行身份验证 部分。
最终令牌配置的示例:
在 Client ID(客户端 ID) 中,输入在 Server UI 的“我的配置文件”下找到的 API 验证序号 。
在 Client Secret(客户端密钥) 中,输入在 Server UI 的“我的配置文件”下找到的 API 密钥 。
在 Client Authentication(客户端身份验证) 中,选择 Send as Basic Auth header(作为 Basic Auth 标头发送) 。
选择 Get New Access Token(获取新访问令牌) 。
设置环境
不要忘记在 Environment(环境) 中设置相同的值。
选择右上角的眼睛图标,然后为 Environment(环境)选择 Add(添加) 。
输入环境的名称。
输入与“设置授权”部分的 第 4 步 相同的 baseUrl、API 验证序号和 API 密钥。
输入环境的 URL。您可以在 Alteryx 系统设置 中找到该 URL 并将其用作 基址 。请参阅“设置授权”部分的 第 4 步 。
选择 保存 。
发送请求
您可以在 Postman 中测试 Server API:对请求授权、发送请求或浏览不同代码类型的请求。
示例
假设您要检索用户拥有的资产列表。
首先,您需要知道特定的用户 ID。
进入 Collections(集合) ,然后选择 Alteryx Server API V3 。
选择 users(用户) ,然后选择 GET Search for User records(用户记录的 GET 搜索) 。
在 params(参数) 选项卡中,您可以使用参数在所有用户记录中进行搜索。
要发送请求,请选择 Send(发送) ,您获得的结果将取决于输入的参数。
在结果中,复制您要为其检索资产列表的用户的 ID。
在另一个选项卡中打开另一个请求。找到 users(用户) ,然后选择 {id} 。
选择 GET Retrieve a full list of assets that a user owns(进行 GET 检索以获得用户拥有的资产的完整列表) 。输入您通过上一请求获得的用户 ID,以获取此用户的资产列表。
注意
当您通过 Postman 发送请求时,请不要忘记向其授权。要向您的请求授权,可以采用下列两种方法:
在 Type(类型) 中,选择 OAuth2 ,然后选择一个可用令牌。
在 Type(类型) 中,选择 Inherit auth from parent(从父级继承身份验证方法) 。系统将使用您为整个集合配置的授权方法。