开始使用InsightAppSec API
生成Insight API密钥
为了与API交互,您需要生成一个API密钥。有两种API密钥:用户密钥和组织密钥。
- 用户密钥:所有角色都可以生成用户密钥。此键与您的帐户相关联,并将跟踪您所做的所有更改和操作。
- Org的钥匙:只有平台管理员可以生成Org密钥。这是一个“超级密钥”,可以在API中跨所有产品执行所有操作。必威下注
虽然平台管理员可以访问用户密钥和组织密钥,但Rapid7建议平台管理员只使用组织密钥。
API关键角色和权限
当您生成API密钥时,InsightAppSec API将继承您的产品角色,并允许您基于这些角色完成特定的操作。平台管理员拥有Org key,可以完成API中的所有操作。
角色和特权随着API不断发展。有关最新的用户权限,请参阅InsightAppSec API文档.
试用用户
如果您有一个免费试用的InsightAppSec,您将拥有与只读用户相同的权限。
看到管理API密钥为更多的信息。
1.生成API密钥
要与Rapid7 InsightAppSec API交互,您需要一个API密钥。下面是生成新API密钥的步骤。
- 登录Rapid7洞察平台。dota2必威联赛
- 点击页面右上角的齿轮图标
- 选择API密钥.
- 使用切换选择下列选项之一:
- 新用户的关键.所有角色都可以生成用户密钥。此键与您的帐户相关联,并将跟踪您所做的所有更改和操作。
- 新组织的关键.只有平台管理员可以生成组织密钥。这是一个“超级密钥”,可以在API中跨所有产品执行所有操作。必威下注
- 一旦生成,请确保复制并安全地存储密钥,因为以后将无法再次访问它
如果丢失了API密钥,则必须删除原来的密钥并生成新的密钥。
如前所述,这个API键将允许您开始与Rapid7 InsightAppSec API进行交互。更具体地说,API密钥用于对InsightAppSec实例进行身份验证,并在该上下文中执行事务。该键将通过单个HTTP头作为每个API请求的一部分传递:X-Api-Key.
2.生成规范文件
Rapid7 InsightAppSec API的完整文档可以在这里找到:https://help.rapid7.com/insightappsec/en-us/api/v1/docs.html
在导航文档时,使用左手边的菜单选择您想要了解更多信息的InsightAppSec组件,然后通过选择单个API操作进一步缩小范围。您还可以通过关键字搜索API文档。
每个单独的操作部分将包含关于URL路径、API参数、请求主体(如果需要)和响应示例的详细信息。所有这些都可以用来构造一个API请求,并在InsightAppSec上下文中执行相关操作。
注意,API文档指南的开头还包含了关于权限、搜索/过滤、API错误和可以在API请求中使用的查询参数的附加信息。
使用OpenAPI/Swagger规范
除了HTML生成的文档,OpenAPI/Swagger规范也可用,可用于自动生成API客户端或在Postman中使用。该规范可以从以下网站下载https://help.rapid7.com/insightappsec/en-us/api/v1/insightappsec-api-v1.json.将此文件与Postman等工具结合使用是更好地熟悉新API的关键。
3.通过邮差访问API
Postman是一个API客户端,它提供了一个简单的用户界面来实现API交互。它可以与InsightAppSec API规范文件一起使用,以自动生成执行API调用的请求。可以使用以下步骤将规范文件导入Postman。这将自动生成执行API调用的请求,当最初熟悉一个新的API端点时,这是非常有用的。
- 开放的邮差。
- 选择进口并选择选择文件并选择下载的InsightAppSec规范文件。
- 选择集合下的新InsightAppSec API部分。
在这个新导入的InsightAppSec API集合中,您可以看到为InsightAppSec中存在的每个组件列出的条目。如果您展开选项并选择一个特定的操作,一个预格式化的请求将出现在右侧,该请求包含操作类型、URL路径、主体(如果需要)和任何必要的标题。
3 a。测试API
尽管这个预格式化的请求包含了进行API调用所需的大部分字段,但仍有几个字段需要更新。当使用导入的规范文件时,可以使用以下步骤在Postman中发出请求。
- 从InsightAppSec集合中选择一个操作。
- 在URL字段中,替换
{{baseurl}}使用正确的值(https://[region].api.insight.rapid7.com/ias/v1)。 - 更新URL中的任何占位符查询参数,例如
指数和排序.如果不确定这些参数,可以从URL中删除它们(包括?). - 在“标题”选项卡下添加一个新的标题,其中的关键字
X-Api-Key值是您之前生成的API密钥。 - 更新请求体中的所有占位符值(如果有的话),用文本表示,例如
<字符串>. - 选择
发送按钮以发出请求。 - 观察收到的响应。状态代码
200距离表示请求成功。如果失败,则响应可能包含一条表示原因的错误消息。
将这些步骤与任何其他调用一起使用,以更好地熟悉InsightAppSec API,同时也要记住,有些调用比其他调用更敏感(例如删除操作)。
