API 淘汰通知與常見問題 (FAQs)
本主題包含 API 淘汰通知,以及針對 API 版本變更的一些常見問題。
建議您隨時掌握這些變更,並相應規劃任何 API 整合的更新。
如需本主題提及之 APIs 的更多資訊,請參閱 API 參考文件 https://dev.megaport.com。
2025 年 9 月 - 全新的 v4 價格 APIs
我們已對價格 APIs 進行重要更新,可能會影響您。新版本 v4 現已提供,並取代先前的 v2 與 v3 價格 APIs。此版本用於擷取所有服務的價格,包括 Ports、MCRs、MVEs、VXCs、Megaport Internet 連線、IXs,以及 Cross Connects 等附加產品。
為確保您的系統持續正常運作,所有與這些 APIs 整合的使用者都必須遷移至最新版本。請開始將您的 API 呼叫轉換至 v4,未來對新舊服務與附加費用的所有價格查詢僅支援此版本。Megaport Terraform Provider 不受本次更新影響。
主要變更如下表所示。淘汰的 v2 與 v3 APIs 將於 2026 年 3 月 15 日全面下線。
如需價格 APIs 的更多資訊,請參閱 https://dev.megaport.com。
| 功能 | 舊版 API | 新版 API |
|---|---|---|
| GET Port 價格 | GET /v2/pricebook/megaport | POST /v4/pricebook/product |
| GET VXC 價格 (v3) | GET /v3/pricebook/vxc | POST /v4/pricebook/product |
| GET Megaport Internet 價格 (v3) | GET /v3/pricebook/vxc | POST /v4/pricebook/product |
| GET MCR 價格 | GET /v2/pricebook/mcr2 | POST /v4/pricebook/product |
| GET MVE 價格 - 無 Megaport Internet (v3) | GET /v3/pricebook/mve | POST /v4/pricebook/product |
| GET IX 價格 | GET /v2/pricebook/ix | POST /v4/pricebook/product |
| GET IP 位址價格(新) | 不適用 | POST /v4/pricebook/product |
| GET Cross Connect 價格(新) | 不適用 | POST /v4/pricebook/addon |
| GET IPsec 價格(新/即將推出) | 不適用 | POST /v4/pricebook/addon |
| GET 合約期限詳細資訊 | GET /v2/product/portTerms/{productUid} | POST /v4/pricebook/product/terms |
2025 年 5 月 - API 版本變更
我們對 API 進行了重要更新,可能會影響您。因此,所有目前與這些端點整合的使用者都必須遷移至最新版本。
主要變更如下表所示。遭到淘汰的 APIs 將於 2025 年 7 月 31 日全面下線。
從 v2 移轉到 v3:
- v3 API 現已提供,且以下項目必須使用:
- 取得所有服務的地點
- 使用使用者名稱與密碼進行 POST 登入
- 通知設定 APIs
- 取得活動日誌
- 發票 APIs(另請注意,
companyId已更新為companyUid,且supplierId已新增至 URL)
從 v3 移轉到 v4:
- 取得 MVE 映像檔詳細資訊
| 功能 | 舊版 API | 新版 API |
|---|---|---|
| GET 位置 傳回可申購 Port、MCR 或 MVE 的資料中心清單。 |
GET /v2/locations | GET /v3/locations |
| POST 使用使用者名稱與密碼登入 | POST /v2/login | POST /v3/login |
| GET 通知設定清單 | GET /v2/notificationPreferences | GET /v3/notificationPreferences |
| PUT 變更通知設定 | PUT /v2/notificationPreferences | PUT /v3/notificationPreferences |
| GET 使用者活動 | GET /v2/activity | GET /v3/activity 以下端點現已可用:
|
| GET 發票 在指定的日期範圍內,傳回公司與計費市場組合的所有發票清單。 |
/v2/company/${companyid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate} |
/v3/company/${companyUid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate} |
| GET 單一發票 以 JSON 格式傳回指定的發票。 |
/v2/company/${companyid}/invoice/ ${invoiceId} |
/v3/company/{companyUId}/supplier/ {supplierId}/invoice/{invoiceId} |
| GET 單一發票 PDF | /v2/company/${companyid}/invoice/ ${invoiceId}/pdf |
/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/pdf |
| GET 單一發票 CSV | /v2/company/${companyId}/invoice/ ${invoiceId}/csv |
/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/csv |
| GET MVE 映像檔詳細資訊 | GET /v3/product/mve/images | GET /v4/product/mve/images |
2024 年 2 月 - 全新的發票 APIs
我們的發票 APIs 正在調整。
為確保您持續取得最準確、最新且完整的發票資料(包含折讓與稅務資訊),您必須遷移至新的發票 API 端點。
如需發票 APIs 的更多資訊,請參閱 https://dev.megaport.com。
哪些發票 APIs 受到影響?
這些 API 端點已被淘汰,並由新的 API 端點取代。
| 功能 | 舊版 API | 新版 API |
|---|---|---|
| GET 發票 | GET /v2/invoice 傳回與該使用者帳戶關聯之公司的發票清單。 |
GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}? 在指定的日期範圍內,傳回公司 ID 與計費市場 ID 的組合之發票清單。 |
| GET 單一發票 | GET v2/invoice/{invoiceId} 傳回指定 invoiceId 的發票。 |
GET /v2/company/${companyId}/invoice/${invoiceId} 以 JSON 格式傳回指定 companyId 與 invoiceId 的發票。 |
| GET 單一發票 PDF | GET /v2/invoice/{invoiceId}/pdf 傳回指定 invoiceId 的發票之 PDF 版本。 |
GET /v2/company/${companyId}/invoice/${invoiceId}/pdf 傳回指定 companyId 與 invoiceId 的發票之 PDF 版本。 |
| GET 單一發票 CSV | GET /v2/invoice/{invoiceId}/csv 傳回指定 invoiceId 的發票之 CSV 版本。 |
GET /v2/company/${companyId}/invoice/${invoiceId}/csv 傳回指定 companyId 與 invoiceId 的發票之 CSV 版本。 |
我要在哪裡找到供應商與公司資訊?
所有新的發票 APIs 都要求您在 API 呼叫中一併提供公司與供應商資訊。您可以從以下 Megaport APIs 取得這些值:
supplierId是在 GET Billing Markets/v2/marketAPI 中,對應供應商所回傳的 “firstPartyId”。companyUid可從 GET Product List/v2/productsAPI 或 GET API Keys/v2/auth/apikeysAPI 取得。companyId可從 GET Company Details/v2/company/companyUidAPI 取得。
我何時需要開始使用新的發票 APIs?
儘快。新的發票 APIs 目前已在正式環境提供,未來與發票相關的任何強化功能只會套用於新 APIs。
舊版發票 APIs 何時會淘汰?
舊版發票 APIs 已被淘汰且不再支援。
我可以找誰取得更多資訊?
請聯絡您的客戶經理或 Megaport 支援團隊。欲知詳情,請參閱 聯絡支援。
2023 年 4 月 - v2 MVE APIs
於 2023 年 4 月,我們推出了全新版本的 Megaport Virtual Edge(MVE)。先前,MVE 以套裝形式提供,包含預設的運算資源、虛擬電路,以及 Megaport Internet 規格。在此最新版本中,我們將 Megaport Internet 拆分,將運算與 Virtual Cross Connect(VXC)及 Megaport Internet 連線分離。透過將運算與傳輸功能解耦,您現在可以進一步自訂網路,以獲得更高層級的可設定性與彈性,滿足您的需求。
MVE 現在也提供多種規格,並將 RAM 提升為先前版本的兩倍,以帶來更佳效能。運算規格現為 2/8、4/16、8/32 與更高容量選項,第一個數字代表 CPU,第二個數字代表可用 RAM 的 GB 數。
為了支援此新功能,已提供 v3 API,可分別將 MVE 與 Megaport Internet 連線做為獨立產品進行價格查詢、驗證、下單、編輯與刪除。既有的 API 整合者若要變更其 Megaport Internet 連線的速率,必須改用新的 v3 API。
因此,除 MVE 與 Megaport Internet 連線外,與其他服務類型(包含 Ports、MCRs、VXCs 與 IXs)之 Validate 與 Buy APIs 整合的使用者,也必須遷移至最新的 v3 版本。除了版本號之外,這些服務類型在 url、request body 或 response body 上並無任何變更。
為維持與既有 API 整合者的回溯相容性,API 使用者可以在 2024 年 9 月 30 日之前,持續使用目前的 v2 Megaport API 呼叫來訂購綑綁的 MVE。使用 v2 APIs 訂購 MVE 時,系統會自動建立一條與所選 MVE 規格相對應之預設速率的 Megaport Internet 連線。
我們鼓勵所有整合者遷移並在訂購 MVE 與 Megaport Internet 連線時開始使用 v3 APIs,以充分運用額外的彈性。
我們的客戶 Portal 已經在以下項目切換為 v3:
擷取 MVE 與 VXC 價格:
- GET /v3/pricebook/mve?locationId={locationId}&vendor={vendor}&size={size}
- GET /v3/pricebook/vxc?bLocationId={bLocationId}&aLocationId={aLocationId}
驗證與購買所有服務類型:
- POST /v3/networkdesign/validate
- POST /v3/networkdesign/buy
更新 VXC(僅限):
- PUT /v3/product/vxc/{productUid}
刪除所有服務類型:
- POST /v3/product/{productUid}/action/{action}
我何時需要開始使用 MVE API v3?
儘快,且最晚不得遲於 2024 年 9 月。MVE v3 APIs 目前已在正式環境提供,未來與 MVE 與 Megaport Internet 連線相關的任何強化功能只會套用於 v3 APIs。
MVE v2 APIs 何時會被淘汰?
MVE v2 APIs 將於 2024 年 9 月 30 日遭到淘汰。
哪些 v2 APIs 受到影響?
下表列出受此變更影響的 v2 APIs:
| 功能 | 舊版 API | 新版 API |
|---|---|---|
| 取得 MVE 價格 | GET /v2/pricebook/mve 傳回 MVE + Megaport Internet 連線的價格。 |
GET /v3/pricebook/mve 僅傳回 MVE 運算的價格。 |
| 取得 VXC 價格 | GET /v2/pricebook/vxc 不會傳回 Megaport Internet 價格。 |
GET /v3/pricebook/vxc 使用 connectType=transit 時,傳回 Megaport Internet 連線的價格。 |
| 驗證所有產品類型的訂單:Port、MCR、MVE、VXC、IX | POST /v2/networkdesign/validate 對於 MVE,同時驗證 MVE + Megaport Internet 連線的訂單。 |
POST /v3/networkdesign/validate 對於 MVE,僅驗證 MVE 的訂單。 Note (備註): 可用大小為: "SMALL" "MEDIUM" "LARGE" "X_LARGE_12". |
| 購買所有產品類型的服務:Port、MCR、MVE、VXC、IX | POST /v2/networkdesign/buy 對於 MVE,同時購買 MVE + Megaport Internet 連線。 |
POST /v3/networkdesign/buy 對於 MVE,僅購買 MVE。 可單獨購買 Megaport Internet 連線。 |
| 更新 VXC 詳細資料 | PUT /v2/product/vxc/{productUid} 無法更新 Megaport Internet 連線。 |
PUT /v3/product/vxc/{productUid} 可更新 Megaport Internet 連線。 |
| 刪除所有產品類型的服務:Port、MCR、MVE、VXC、IX | POST /v2/product/{productUid}/ action/{action} |
POST /v3/product/{productUid}/ action/{action} |
如果我未能及時完成移轉會怎樣?
您的 MVE 整合將停止運作,且您將無法訂購新的 MVE 或更新現有的 MVE。如需更多資訊,請聯絡您的客戶經理。
我可以找誰取得更多資訊?
請聯絡您的客戶經理或 Megaport 支援團隊。欲知詳情,請參閱 聯絡支援。