API 廃止通知およびよくある質問(FAQs)
このトピックには、API の廃止通知および API バージョン変更に関する一般的な質問が含まれています。
これらの変更に常に最新の状態を保ち、API 統合の更新を計画的に行うことをお勧めします。
このトピックで言及されている API の詳細については、API リファレンスを参照してください https://dev.megaport.com。
2025年5月 - API バージョンの変更
いくつかの重要な API の更新を行いました。これにより、これらのエンドポイントと現在統合しているすべてのユーザーは、最新バージョンに移行する必要があります。
主要な変更点は次の表に記載されています。廃止される API は 2025年7月31日 に完全に廃止されます。
v2からv3への移行:
- v3 API は次のために使用可能になり、必要となっています:
- すべてのサービスの場所を取得
- ユーザー名とパスワードでログイン
- 通知設定 API
- アクティビティログを取得
- 請求書 API(
companyIdがcompanyUidに更新され、supplierIdが URL に追加されたことにも注意してください)
v3からv4への移行:
- GET MVE 画像の詳細
| 機能 | 旧 API | 新 API |
|---|---|---|
| 場所を取得 Port, MCR, または MVE を発注できるデータセンターのリストを返します。 |
GET /v2/locations | GET /v3/locations |
| ユーザー名とパスワードでログイン | POST /v2/login | POST /v3/login |
| 通知設定のリストを取得 | GET /v2/notificationPreferences | GET /v3/notificationPreferences |
| 通知設定を変更 | PUT /v2/notificationPreferences | PUT /v3/notificationPreferences |
| ユーザーアクティビティを取得 | GET /v2/activity | GET /v3/activity これらのエンドポイントはすべて現在利用可能です:
|
| 請求書を取得 指定された日付範囲内で会社および請求市場の組み合わせのすべての請求書を返します。 |
/v2/company/${companyid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate} |
/v3/company/${companyUid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate} |
| 単一の請求書を取得 指定した請求書を JSON 形式で返します。 |
/v2/company/${companyid}/invoice/ ${invoiceId} |
/v3/company/{companyUId}/supplier/ {supplierId}/invoice/{invoiceId} |
| 単一請求書の PDF を取得 | /v2/company/${companyid}/invoice/ ${invoiceId}/pdf |
/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/pdf |
| 単一請求書の CSV を取得 | /v2/company/${companyId}/invoice/ ${invoiceId}/csv |
/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/csv |
| MVE 画像の詳細を取得 | GET /v3/product/mve/images | GET /v4/product/mve/images |
2024年2月 - 新しい請求書 API
請求書 API が変更されます。
正確で最新かつ完全な請求書データ(クレジットノートや税情報を含む)を受け取り続けるために、新しい請求書 API エンドポイントへの移行が必要です。
請求書 API の詳細については、https://dev.megaport.comを参照してください。
影響を受ける請求書 API はどれですか?
これらの API エンドポイントは廃止され、新しい API エンドポイントに置き換えられました。
| 機能 | 旧 API | 新 API |
|---|---|---|
| 請求書を取得 | GET /v2/invoice ユーザーアカウントに関連付けられた会社の請求書一覧を返します。 |
GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}? 会社 ID および請求市場 ID の組み合わせに対して、指定された日付範囲内の請求書のリストを返します。 |
| 単一の請求書を取得 | GET v2/invoice/{invoiceId} 指定された invoiceId の請求書を返します。 |
GET /v2/company/${companyId}/invoice/${invoiceId} 指定された companyId および invoiceId の請求書を JSON 形式で返します。 |
| 単一請求書の PDF を取得 | GET /v2/invoice/{invoiceId}/pdf 指定された invoiceId の請求書の PDF バージョンを返します。 |
GET /v2/company/${companyId}/invoice/${invoiceId}/pdf 指定された companyId および invoiceId の請求書の PDF バージョンを返します。 |
| 単一請求書の CSV を取得 | GET /v2/invoice/{invoiceId}/csv 指定された invoiceId の請求書の CSV バージョンを返します。 |
GET /v2/company/${companyId}/invoice/${invoiceId}/csv 指定された companyId および invoiceId の請求書の CSV バージョンを返します。 |
サプライヤーおよび会社情報はどこで見つけられますか?
新しい請求書 API では、API 呼び出しの一部として会社およびサプライヤー情報を送信する必要があります。これらの値は次の Megaport API から取得できます:
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 で返されます。
いつ新しい請求書 API を使用し始める必要がありますか?
できるだけ早く。新しい請求書 API は現在本番環境で利用可能であり、請求書に関連する将来の改善は新しい API のみに適用されます。
従来の請求書 API はいつ廃止されますか?
従来の請求書 API は廃止され、サポートされていません。
詳細はどこに問い合わせればよいですか?
アカウントマネージャーまたは Megaport サポートにお問い合わせください。詳細については、サポートへのお問い合わせを参照してください。
2023年4月 - v2 MVE API
2023年4月、新バージョンの Megaport Virtual Edge (MVE) をリリースしました。以前は、MVE はプリセットのコンピューティング、Virtual Cross Connect、および Megaport Internet 仕様のバンドルとして提供されていました。この最新バージョンにより、計算機能を Virtual Cross Connect (VXC) と Megaport Internet 接続から切り離しました。コンピューティングとトランジット機能を分けることで、ネットワークをカスタマイズしてニーズに合わせて設定できる新しいレベルの構成可能性と柔軟性を得ることができます。
MVE は現在、複数のサイズで利用可能で、以前のバージョンよりも RAM が倍になり、パフォーマンスが向上しています。コンピュートサイズは2/8、4/16、8/32と、高容量なオプションが利用可能で、最初の数字がCPU、2番目の数字が利用可能なGBのRAMを示しています。
この新機能を有効にするために、価格を取得、確認、注文、編集、および MVE と Megaport Internet 接続を別々に削除するための v3 API が作成されました。Megaport Internet 接続の速度を変更したい既存のAPI統合者は、新しいv3APIとの統合を行う必要があります。
その結果、Ports、MCR、VXC、IX、MVE および Megaport Internet 接続など、その他のサービスタイプの Validate and Buy API と統合しているユーザーは、最新の v3 バージョンに移行する必要があります。これらのサービスタイプには、バージョン以外に URL、リクエストボディ、またはレスポンスボディには変更は適用されません。
既存のAPI統合者との後方互換性を維持するために、バンドル MVE API 呼び出しを使用して、バンドル MVE を発注し続けることができますが、2024年9月30日 には従来の v2 API は廃止されます。v2 API を使用して MVE を注文する場合、選択した MVE サイズに関連付けられたデフォルト速度で Megaport Internet 接続が自動的に作成されます。
すべての統合者は、MVE と Megaport Internet 接続を発注する際に v3 API を使用し始め、追加の柔軟性を最大限に活用することを奨励しています。
当社の顧客 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 API は現在本番環境で利用可能であり、MVE および Megaport Internet 接続に関連する将来の改善は v3 API のみ適用されます。
MVE v2 API はいつ廃止されますか?
MVE v2 API は 2024年9月30日に廃止されます。
どの v2 API が影響を受けますか?
この表は、これらの変更に影響を受ける v2 API を示しています:
| 機能 | 旧 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 のみの注文を検証します。 注記: 利用可能なサイズは: "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 サポートにお問い合わせください。詳細については、サポートへのお問い合わせを参照してください。