HTTP请求

您可以将HTTP Requests插件与您想要添加到InsightConnect中的任何RESTful服务一起使用,或者与现有InsightConnect插件的REST api一起使用。HTTP Requests插件允许您集成那些还没有作为InsightConnect插件可用的服务,或者定制我们的插件目前不支持的操作。了解关于RESTful服务的更多信息https://restfulapi.net/

InsightConnect支持得到帖子补丁, 和删除使用REST插件的HTTP方法。

虽然HTTP Requests插件对于解决InsightConnect还不支持的插件需求很有用,但我们不推荐使用HTTP Requests插件用于使用OAuth认证和授权的服务。OAuth过程需要多个身份验证令牌,并需要多个HTTP请求插件来适当地将API服务连接到InsightConnect。

收集HTTP请求插件配置信息

每个API都有不同的需求,但是您总是需要API请求客户端URL (cURL)来配置HTTP Requests插件。API服务文档将帮助您了解API支持什么方法,API提供什么JSON输出,以及将服务与InsightConnect集成所需的任何必要配置细节。

API文档有时被称为开发人员文档。有关更多信息,请访问服务的网站或支持门户网站。

配置一个HTTP请求插件连接

要配置HTTP请求插件连接,添加新连接连接设置>插件和工具,或在工作流中的插件配置期间。接下来,将连接参数配置为以下值:

将凭证传递为标题

如果您需要传递任何类型的凭据或API密钥进行授权,请注意当前未加密标头值。

连接参数 可接受的价值
验证类型 有许多身份验证类型可供选择,包括:基本Auth,摘要验证,持票人令牌,Rapid7 Insight,Opsgenie,Pendo和Succe,允许您生成自己的身份验证标题。有关自定义身份验证方法的详细信息,请参阅下面的自定义身份验证部分。
基本认证证书 您要使用的API服务所需的任何用户名或密码,如字符串。如果您选择了基本的Auth或Digest Auth,则需要此字段验证类型
基本URL(必需) API的基本URL高达,包括最后一个前向斜杠(资源特定路径之前),作为字符串。这是一个必填字段。
默认标题 json中的任何API标题都需要操作。除非由您指定的任何操作特定标头覆盖,否则该插件将使用这些。使用自定义类型时需要此字段验证类型.要将加密密钥传递为标题值,请输入您的密钥秘密密钥输入并将字段中标题的值设置为custom_secret_input.而不是secret键值。插件将替换custom_secret_input.使用存储在秘密密钥当插件运行时输入。
秘密密钥 任何凭据密钥,如字符串。如果使用承载令牌、Rapid7 Insight、OpsGenie或Pendo作为验证类型或在使用custom_secret_input.默认标题字段的自定义验证类型
SSL验证(必填) 布尔值:真的如果您想验证SSL证书,如果你不。

自定义身份验证

可以通过选择。创建自己的身份验证头自定义身份验证验证类型字段。在json对象中创建头部默认标题字段。注意,传递到此字段的任何值(包括凭据)都没有加密。如果需要传递带有秘密凭证的自定义标头,请输入custom_secret_input.而不是输入您的认证秘密值(如API Key, secret Key, Password):

         
json
1
2
“x-api-key”“自定义密码输入”
3.

接下来,将头部身份验证值添加到秘密密钥领域这将确保您的敏感信息作为机密存储在InsightConnect中。运行插件时,它将替换custom_secret_input.身份验证标题中的文本具有值秘密密钥

配置HTTP请求插件操作

添加HTTP请求插件时动作步骤到工作流程,您需要选择或配置一个连接,然后为操作配置步骤输入字段。

每个动作对应一个HTTP方法。每个输入变量选项的可接受值如下:

输入变量 可接受的价值 使用输入变量的操作
路线(必需) 资源的路径包括包含基本URL的资源,作为字符串。
  • 得到
  • 帖子
  • 删除
  • 补丁
标题 JSON中的任何API标题,包括API键,您需要操作。在步骤输入中添加的标头将覆盖HTTP请求插件连接中的默认标题。

如果您知道您正在使用的连接,请将其留下此空白正确配置了HTTP方法。
  • 得到
  • 帖子
  • 删除
  • 补丁
身体 在进行HTTP请求调用时提交给服务器的有效负载
  • 帖子
  • 删除
  • 补丁

示例HTTP请求插件配置

要向您展示什么格式格式的基础URL-Route对,我们将使用星球大战APIhttps://swapi.dev/documentation举个例子。

在URL中可以找到包含Luke Skywalker数据的对象的完整路径httphttps://swapi.dev/api/people/1.基础URL在《星球大战》API文档中描述为https://swapi.dev/api/,所以我们知道该路线应该是完整的URL中的任何内容。插件配置的路由是人/ 1

要获得进一步的帮助,请参考下面的示例屏幕截图。

星球大战API的示例连接配置

正确格式的API基URL的示例,以正斜杠结尾

用于检索Luke Skywalker实体的插件输入示例

在此实体的正确格式化路由示例,从未向前斜杠开始

其他示例连接配置

基本授权

基本身份验证

持卡人令牌

承载令牌认证

习俗

自定义身份验证

消化

摘要认证

奥普斯格尼

OpsGenie身份验证

彭多

Pendo身份验证

Rapid7洞察力

Rapid7洞察力身份验证

使用邮递员测试HTTP请求插件配置

在激活工作流之前,可以使用Postman客户端测试配置值。这对于需要授权或身份验证的API特别有用。

下载邮差应用程序https://www.getpostman.com/products.. 免费邮递员计划足以测试API。

要用你选择的API测试HTTP请求插件:

  1. 在邮递员中,选择HTTP请求插件操作的HTTP方法在“Enter请求URL”字段的左侧的下拉列表中。
  2. 复制API请求(基本URL +路由)的完整卷轴,并将其粘贴到“输入请求URL”字段中。
  3. 如果您的API要求API键,以键的名称输入或粘贴到“Params”选项卡的“键”列下的一个打开单元格中。然后将键值或令牌粘贴到相应的“值”列单元格中。API键名应将您输入的InsightConnect与API标头匹配。
  4. 点击蓝色按钮发送按钮发送请求。
  5. 检查Postman中的输出。如果看到意外情况或收到错误消息,请访问API文档以获取故障排除帮助。

如果测试基础URL和路由并在Postman中接收到意外输出,则API可能需要在路由的最后一个正斜杠。在上面的例子中,SWAPI不需要最后的正斜杠for人/ 1但是,某些API将无法在没有它的情况下正确发送数据。