产品中心
Eggplant Web Performance Analyzer
该 API 可用于从Eggplant Web Performance Analyzer以编程方式提取数据。您还可以使用 API 生成本地仪表板或将Eggplant Web 性能分析器和性能检查集成到您的持续集成或持续部署解决方案中。

接口路径

除了下面详述的身份验证之外,您可以向以下基本 URL发出Eggplant Web Performance Analyzer API 请求:

https://api.pa.eggplant.cloud/pa/v1

请求必须使用 HTTPS。请注意,/v1 是指正在使用的 API 的版本。

验证

要访问 API,您必须设置一个客户端,该客户端为您提供客户端 ID 和机密,您的应用程序使用这些 ID 和密钥生成身份验证(承载)令牌。您向 API 发出的每个请求都使用不记名令牌。

您可以在应用程序中嵌入客户端 ID 和密钥。永远不需要在您的客户端应用程序中包含您的登录用户名和密码。

您在客户端凭据门户中管理您的客户端信息(客户端 ID 和客户端机密对),这确保您始终可以控制哪些客户端应用程序以您的用户权限运行。您可以随时撤消访问权限。

创建客户端

使用您的常规门户登录用户名和密码登录到Client Credentials 门户。

在添加客户端部分创建您的客户端 ID 和客户端密钥。输入客户端的描述,然后点击Generate Keys。

记下生成的客户端 ID 和客户端密钥。您现在可以注销客户端凭据门户,因为 API 请求不需要它。

使用您生成的 client_id 和 client_secret 来请求不记名令牌。

要求



身份验证是通过标准的 HTTP 基本身份验证进行的,其中请求标头需要包含一个 base64 编码的client_id和client_secret字符串,用冒号分隔。

例如,如果您的 client_id 是 client 而您的 client_secret 是 secret,那么您将使用 base64对整个字符串client:secret进行编码,即 Y2xpZW50OnNlY3JldA==

回复



参数



如果您尝试使用已过期的不记名令牌,或者在客户端已被撤销的情况下,您将看到HTTP 401 未授权响应,并且需要如上所述重新验证或设置新客户端。

使用领域

API 的所有请求都必须包含要从中获取数据的领域的 ID 。您在登录 Portal Hub 时选择的 Performance Analyzer 帐户等同于您在使用 API 时将引用的领域。

该客户端凭证门户网站列出了您可以访问每个帐户的境界ID:



在本例中,Acme Production 帐户的领域为 12345,可用于任何后续 API 请求。

如果要以编程方式识别用于特定帐户的领域的 ID,可以按如下方式向 API 发出请求:

要求



使用Eggplant Web Performance Analyzer的 API 时,服务始终为 6,因此请使用它来查询您的领域。

回复