企业

API参考

  • 最近更新时间:2022年4月6日

  • 阅读时间:2分钟

Burp Suite Enterprise Edition提供了两个API,您可以使用其他第三方软件与系统进行交互。GraphQL API提供了最广泛的功能,建议用于新的集成,而REST API为熟悉的用户提供了简单的迁移Burp Suite专业人士API。

GraphQL API

如果您打算建立新的集成bepaly下载软件 使用您自己的软件或第三方工具,我们建议尽可能使用GraphQL API。

GraphQL API几乎公开了所有核心功能和数据bepaly下载软件 。除其他外,您可以使用API​​来:

  • 创建和编辑站点。
  • 安排一次性和定期扫描。
  • 创建和编辑自定义扫描配置。
  • 将文件夹添加到您的站点树中。
  • 获取扫描结果和报告。
  • 对于标准部署,请管理您的扫描机池。
  • 将扫描作为构建管道的一部分集成。

更多信息:

REST API

Burp Suite Enterprise Edition的REST API提供了一种从CI系统启动扫描并在报告某些问题时构建的基本方法。它与Burp Suite Professional API密切相关,代表了从该API表面的简单迁移。

虽然REST API可能对Burp Suite Professional的用户更熟悉,但它只能揭示有限的BURP Suite Enterprise Edition的功能。因此,我们强烈建议在可能的情况下使用GraphQL API进行新的集成。

要查看REST API的交互式文档,请浏览:[Enterprise Server URL]/API/[API键]

使用API

为了使用Burp Suite Enterprise Edition的API,您将需要设置API用户。API用户每个都有一个唯一的API密钥,使其在提出请求时能够进行身份验证。

请注意,Burp Suite Enterprise Edition的用户角色以与UI用户相同的方式适用于API用户。您只能使用API​​执行用户权限与角色允许关联的那些任务。因此,您应确保设置的任何API用户都具有正确的角色。

更多信息:

  • 有关设置API用户的更多信息,请参阅创建API用户。

  • 有关在Burp Suite Enterprise Edition中配置角色的更多信息,请参见角色