Proxy 伺服器 API 指令

一旦 Proxy 伺服器啟動，您就可以啟動 Proxy 實例，並且將您的資料流量傳送至您的應用程式。
如果網站是受保護的 (HTTPS)，請執行下列其中一個動作以避免 SSL 警告：
  • 下載憑證並且在瀏覽器上安裝。
  • 使用 CLI 選項 -importRootCertificate 來安裝您自己的根憑證
  • 在執行 StartProxy 指令時，使用 proxyCertificate 參數來提供伺服器憑證。
有四個指令，如下所述。
註： 支援 Node.js 第 12 版和更高版本。

文件

您可以檢視完整的 REST API 說明文件：
  • 在 Swagger 中，藉由在瀏覽器中輸入：
    http(s)://<server>:<port>
  • 在 ASoC 說明文件中，這裡。

"StartProxy"

啟動在指定埠上接聽的 Proxy。
  • URL：http://[server]:[port]/automation/StartProxy/<recordingPort>
  • 要求類型：POST 或 GET（如果使用 chainedProxy、proxyCertificate 和 clientCertificate，則要求是 POST；否則就是 GET）

    要求內文必須是 JSON 格式

    伺服器 = 其上安裝 Proxy 伺服器之機器的 IP 位址。（預設值為 localhost）

    埠 = Proxy 伺服器在其上接聽的埠

    recordingPort = 記錄 Proxy 接聽埠（如果設定為 "0"，則會選擇隨機埠和在 HTTP 回應中傳回的埠號）

選用參數 Type 說明
chainedProxy 字串 使用以下格式配置上游（已鏈結） Proxy：[ip]:[port]。這樣會置換已鏈結的 Proxy 規則檔案 (proxy.chain)。
proxyCertificate 憑證 憑證必須是 JSON 物件，具有兩個欄位：“content” 具有 base64 編碼的憑證檔案內容，“password” 具有檔案的密碼。
clientCertificate 憑證 憑證必須是 JSON 物件，具有兩個欄位：“content” 具有 base64 編碼的憑證檔案內容，“password” 具有檔案的密碼。
已加密 布林 加密所有資料流量。範例：

/StartProxy /<recordingPort>?encrypted=true

"StopProxy"

停止在指定埠上接聽的 Proxy。
  • URL：http://[server]:[port]/automation/StopProxy/<recordingPort>
  • 要求類型：GET
提示： 將埠設定為「0」不會停止所有已開啟的 Proxy。使用「StopAllProxies」來完成這個操作。

"StopAllProxies"

這個指令會停止所有埠上的所有記錄 Proxy，包含其他使用者所啟動的記錄 Proxy。
  • URL：http://[server]:[port]/automation/StopAllProxies
  • 要求類型：POST

"EncryptDastConfig"

上傳 DAST.CONFIG 檔案以進行加密。
  • URL：http://[server]:[port]/automation/EncryptDastConfig
  • 要求類型：POST
    dastFile = 要加密的 DAST.CONFIG 檔案。要求的預期內容-類型是多組件/表單資料。要求應該包含名為「dastFile」的單一檔案參數。範例： 
    Content-Type: multipart/form-data; Content-Disposition: form-data; name="<dast.config>"

    回應中會傳回唯一 ID，而您使用這個 ID 來下載加密的檔案

"DownloadEncryptedDast"

下載加密的 DAST.CONFIG 檔案（使用 EncryptDastConfig API 上傳）。
註： 下載檔案時，加密和未加密的 DAST.CONFIG 檔案都會從 Proxy 伺服器上刪除。
  • URL：http://[server]:[port]/automation/DownloadEncryptedDastConfig/<uuid>
  • 要求類型：GET

    uuid = 在 EncryptDastConfig API 回應中收到的唯一 ID

"Traffic"

將埠所識別來自 Proxy 的記錄資料下載為 DAST.CONFIG 檔案。
  • URL：http://[server]:[port]/automation/Traffic/<recordingPort>
  • 要求類型：GET

    埠 = Proxy 伺服器在其上接聽的埠

    recordingPort = 記錄 Proxy 接聽埠

"Certificate"

將 Proxy 伺服器所使用的自簽「主要憑證管理中心」下載為 PEM 檔案。
  • URL：http://[server]:[port]/automation/Certificate
  • 要求類型：GET
  • 伺服器 = 其上安裝 Proxy 伺服器之機器的 IP 位址。（預設值為 localhost）
  • 埠 = Proxy 伺服器在其上接聽的埠