Megaport API 概觀
Megaport 提供公開 API,可用於透過 Megaport Portal 存取所有可用的服務。 您可以使用此 API 自動化您的 Megaport 佈建,以節省時間與精力。
Megaport API 建立於 REST 之上。該 API 具有可預期的 URL、接受表單編碼的請求本文、回傳 JSON 編碼的回應,並使用標準的 HTTP 回應代碼。
本節主題將逐步引導您完成所需的 API 呼叫,以執行常見作業,例如登入、建立一個 Port,以及從該 Port 建立一個 VXC 連向雲端供應商。
除了這些主題之外,您可以在下列位置檢視完整的 API 參考 https://dev.megaport.com。
備註
我們會不定期在發佈新功能時更新、變更版本並將 API 標記為棄用。建議您隨時掌握這些變更,並相應規劃任何 API 整合的更新。如需更多資訊,請參閱 API 棄用通知與常見問題 (FAQ)。
環境
API 提供兩個伺服器環境:
-
正式環境 – https://api.megaport.com
您需自行負責在此系統中訂購的任何服務與相關費用。透過 https://api.megaport.com 的 API 變更會反映在 Megaport Portal。
-
Staging(測試)環境 – https://api-staging.megaport.com
您可以在此 Staging 環境中測試任何動作,API 呼叫與回應會與正式系統相同,但服務不會被部署,且您不會因任何操作而被計費。您的 Staging 入口網站帳戶會反映所建立的 Staging 服務;然而,這些服務將每 24 小時重設一次。
您可以使用正式環境的認證登入 Staging 環境並訂購或編輯服務。(新的使用者帳戶需 24 小時後才可在 Staging 使用。)
透過 https://api-staging.megaport.com 的 API 變更會反映在 Staging Portal。
備註
這些 API 主題中的請求會使用 {baseUrl} 變數。您可以將此變數替換為 Staging URL(https://api-staging.megaport.com)或正式環境 URL(https://api.megaport.com),視您要測試組態或在正式部署上作業而定。 如果您使用 Postman 集合(於下一節描述),可以在集合中定義 environment variables,以自動填入 API 請求中的 baseUrl 值,並可輕鬆在 Staging 與正式環境之間切換。
開始使用 API 與 Postman
在撰寫並部署用於呼叫 Megaport API 的用戶端程式碼時,您可以使用任何偏好的語言,從 Java 到 Python 皆可。
若要逐步完成這些 API 主題中的教學,我們建議使用匯入了 Megaport 集合的 Postman 用戶端。
Postman 是一款直覺且強大的 HTTP 用戶端,可協助建置、測試與修改 API。您可以使用它與任何 API 的各項功能互動。Postman 集合是一組預先建好的請求,依資料夾組織,可輕鬆匯出並與他人分享。
在您能於 Postman 中開始使用 Megaport 集合之前,您需要一個 Megaport 帳戶,並且需要安裝 Postman。
在 Postman 設定 Megaport 集合
- 從 dev.megaport.com 下載 Postman API 集合。
按一下連結頁面右上角的 Run In Postman(在 Postman 中執行) 按鈕。