HTTP请求

您可以使用HTTP请求插件与您要添加到InsightConnect的任何RESTful Service，或使用现有InsightConnect插件的REST API。HTTP请求插件允许您集成尚未作为InsightConnect插件的服务或自定义我们插件当前不支持的操作。了解有关RESTful Services的更多信息https://restfulapi.net/．

InsightConnect支持这一点得到那邮政那放那修补,删除HTTP方法使用REST插件。

收集HTTP请求插件配置信息

每个API都会有不同的要求，但您将始终需要API请求客户端URL（CURL）来配置HTTP请求插件。API服务文档将帮助您了解API支持的方法，JSON输出API提供的方法以及您将需要与InsightConnect集成服务的任何必需配置详细信息。

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

配置HTTP请求插件连接

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

连接参数	可接受的值
身份验证类型	有许多认证类型可供选择，包括:基本认证、摘要认证、承载Token、Rapid7 Insight、OpsGenie、Pendo和Custom，它们允许你生成自己的认证头。有关自定义身份验证方法的更多信息，请参阅下面的自定义身份验证一节。
基本验证凭证	您想要使用的API服务所需的任何用户名或密码，如字符串。如果您选择基本认证或摘要认证作为身份验证类型．
基本URL（必填）	API的基本URL直到并包括最后一个必需的正斜杠(在特定资源路径之前)，作为字符串。这是必填项。
默认标题	操作所需的任何JSON格式的API报头。插件将默认使用这些，除非被你指定的特定于动作的头文件覆盖。属性的自定义类型时，此字段是必需的身份验证类型．要将加密的密钥作为头值传递，请在密钥输入并设置字段中标题的值CUSTOM_SECRET_INPUT而不是秘密关键价值。插件将更换CUSTOM_SECRET_INPUT使用加密密钥存储在密钥插件运行时输入。
密钥	任何凭据密钥，作为字符串。如果使用承载令牌，RAPID7 Insight，OPSGENIE或PENDO，则需要此字段身份验证类型或使用时CUSTOM_SECRET_INPUT在里面默认标题定制的领域身份验证类型．
SSL验证(必需)	布尔值：真正的如果要验证SSL证书，错误的如果你没有。

自定义身份验证

您可以通过选择来创建自己的身份验证标题自定义身份验证在里面身份验证类型字段。的JSON对象创建您的头部默认标题字段。请注意，包含传递到此字段的凭据的任何值都不会加密。如果您需要通过秘密凭据传递自定义标题，请输入CUSTOM_SECRET_INPUT如以下示例所示，而不是输入身份验证秘密值（例如API密钥，密钥，密码）：

         

          杰森

           
          
         

          

           

            1
           {
          
          

           

            2
           “x-api-key”：“custom_secret_input”
          
          

           

            3.
           }
          

接下来，将您的头身份验证值添加到密钥字段。这将确保您的敏感信息作为InsightConnect中的秘密存储。运行插件时，它将替换CUSTOM_SECRET_INPUT值为的身份验证头中的文本密钥．

配置HTTP请求插件操作

当添加一个HTTP请求插件行动步骤对于工作流，您需要选择或配置连接，然后为操作配置步骤输入字段。

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

输入变量	可接受的值	使用输入变量的操作
路线（必填）	不包含基本URL的资源路径，以字符串形式。	得到 放 邮政 删除 修补
头	任何JSON格式的API头，包括操作所需的API键。在步骤输入中添加的头将覆盖HTTP Requests插件连接中的默认头。 如果您知道为HTTP方法正确配置了用于操作的连接，则可以将此选项留空。	得到 放 邮政 删除 修补
身体	在制作HTTP请求调用时，有效载荷将提交给服务器	放 邮政 删除 修补

HTTP请求插件配置示例

为了向您展示正确格式化的Base url -路由对是什么样的，我们将使用来自https://swapi.dev/documentation.作为一个例子。

在URL中找到包含Luke Skywalker上的数据的对象的完整路径http https://swapi.dev/api/people/1.．基本URL在星球大战API文档中描述为https://swapi.dev/api/，因此我们知道路由应该是后面的完整URL中的任何内容。插件配置的路径是人/ 1．

有关进一步的帮助，请参阅以下示例屏幕截图。

Star Wars API的连接配置示例

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

其他示例连接配置

基本验证

不记名的令牌

风俗

消化

opsgenie.

佩皮

Rapid7 Insight.

使用Postman测试HTTP请求插件配置

您可以在激活工作流程之前使用邮递员来测试您的配置值。这对于需要授权或认证的API尤其有用。

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

要使用您选择的API测试HTTP请求插件：

1. 在Postman中，在“Enter request URL”字段左边的下拉框中为您的HTTP请求插件操作选择HTTP方法。
2. 复制API请求的完整cURL (base URL + route)，并将其粘贴到“Enter request URL”字段中。
3. 如果你的API需要一个API键，在“Params”选项卡的“key”列下的一个打开单元格中输入或粘贴键的名称。然后将键值或令牌粘贴到相应的“value”列单元格中。API键名应该与您在InsightConnect中输入的API头相匹配。
4. 点击蓝色发送按钮发送请求。
5. 检查邮递员的输出。如果您看到意外或收到错误消息，请访问API的文档以进行故障排除帮助。