dota2必威联赛洞察平台API概述

洞察平台dota2必威联赛提供了一个API，允许您轻松地将您的安全解决方案与我们的洞察产品集成。它由几个独立的REST api组成，它们共享一个端点、身份验证机制和设计，以便您可以与我们的Insight产品交互。

确保生成API密钥

在与Insight Platform api交互之前，您需dota2必威联赛要生成一个API密匙。

端点

API端点表示您正在请求的资源或数据所在的位置。大多数Indota2必威联赛sight Platform api都可以根据您所在的位置通过一个集中的区域端点来访问。例如，如果你在美国，区域端点是us.api.insight.rapid7.com。

要确定端点，请查找承载数据的区域的区域代码。最简单的方法是登录您的Insight账户，访问Insight产品，并在URL中查找区域代码。区域代码为域名的前两个字母。在URL us.idr.insight.rapid7.com中，区域代码是我们。如果您没有看到地区代码，请确保您正在访问特定的产品，如InsightIDR，而不是您的Insight帐户页面。

使用区域代码来确定API端点:https:// < REGION_CODE > .api.insight.rapid7.com。看到地区代码为更多的信息。

身份验证

通过一个HTTP报头X-Api-Key传递API密钥来执行身份验证。必须将密钥传递给所有请求。

          
           旋度
            
           
          

           
            
             1
            curl -H "X-Api-Key: API_KEY" https://us.api.insight.rapid7.com/validate
           
           
            
             2
            
           
           
            
             3.
            HTTP / 1.1 200年成功
           
           
            
             4
            ｛
           
           
            
             5
            “消息”:“授权”
           
           
            
             6
            ｝

使用无效凭据进行身份验证将返回401 Unauthorized消息。

          
           旋度
            
           
          

           
            
             1
            curl -i -H "X-Api-Key: INVALID_API_KEY" https://us.api.insight.rapid7.com/validate
           
           
            
             2
            
           
           
            
             3.
            HTTP / 1.1 401未经授权
           
           
            
             4
            ｛
           
           
            
             5
            “消息”:“未经授权的”
           
           
            
             6
            ｝

版本控制

洞察平台dota2必威联赛API由几个独立的REST API组成，它们共享一个公共端点、身份验证和设计模式。每个API都声明了自己的版本。向后兼容优于API版本控制，每个API只会实现一个新版本，以应对破坏的更改。

用户需要在URL中指定API版本。

例如:

          
           文本
            
           
          

           
            
             1
            https://us.api.insight.rapid7.com/idr/v1/investigations
           
           
            
             2

分页

返回多个项的请求可以被分页。当对响应进行分页时，它将包含描述当前页面的元数据部分和包含响应数据的数据部分。

例如:

          
           文本
            
           
          

           
            
             1
            ｛
           
           
            
             2
            “数据”:(
           
           
            
             3.
            {"id": 3， "name": "vm-101"}，
           
           
            
             4
            {"id": 4， "name": "vm-102"}
           
           
            
             5
            ),
           
           
            
             6
            “元数据”:{
           
           
            
             7
            “指数”:1、
           
           
            
             8
            “大小”:2
           
           
            
             9
            “total_pages”:4
           
           
            
             10
            “total_data”:7
           
           
            
             11
            ｝
           
           
            
             12
            ｝
           
           
            
             13

元数据部分可能包含以下属性:

指数—当前页面，从0开始。将始终提供此值。
大小—当前页面的数据项数。将始终提供此值。
Total_pages-组成完整响应的总页数。如果可能的话，我们将提供这种服务。
Total_data—组成完整响应的数据项的总数。如果可能的话，我们将提供这种服务。
排序-用于对完整响应进行排序的属性。如果响应已排序，则将提供此选项。

您可以使用查询参数控制返回哪个页面。

例如:

          
           文本
            
           
          

           
            
             1
            https://us.api.insight.rapid7.com/idr/v1/investigations?index=3&size=50&sort=type,ASC,created,DESC

用于分页的查询参数包括:

指数-返回的页面，从0开始
大小-每页要返回的项目数。注意:为了保持API的性能，返回的大小可能会小于请求的大小。始终检查元数据。响应中的尺寸参数。
排序—键，顺序对排序，由逗号分隔。该键是给定API支持的排序键之一。Order是ASC中的一种，表示升序，DESC表示降序。可以通过指定多个键、顺序对来提供多个排序键。请注意，这可能不支持某些api。您可以从产品的API文档中验证这一点。

速度限制

API请求可能受到速率限制。当速率限制生效时，响应将返回报头以显示您当前的速率限制状态。

例如:

          
           旋度
            
           
          

           
            
             1
            curl -i -H "X-Api-Key: API_KEY" https://us.api.insight.rapid7.com/
           
           
            
             2
            
           
           
            
             3.
            HTTP / 1.1 200 OK
           
           
            
             4
            RateLimit-Limit: 1000
           
           
            
             5
            RateLimit-Remaining: 412
           
           
            
             6
            RateLimit-Reset: 1531019617

速率限制的参数包括:

RateLimit-Limit-你被允许在速率限制窗口的请求总数。速率限制窗口通常为15或60分钟，但因API而异。
- RateLimit-Remaining—当前限速窗口中剩余的请求数。
- RateLimit-Reset—当前速率限制窗口重置时的时间，以UTC纪元秒为单位。

我们可以在任何时候开始执行或改变速率限制，以确保API性能对所有客户是一致的。