Megaport API

Megaportは、Megaport Portalを通じて利用可能なすべてのサービスにアクセスするためのパブリックAPIを提供します。 このAPIを使用して、Megaportプロビジョニングを自動化し、時間と労力を節約できます。

Megaport APIはRESTに基づいています。APIには予測可能なURLがあり、フォームでエンコードされた依頼ボディを受け入れ、JSONでエンコードされた応答を返し、標準のHTTP応答コードを使用します。

このセクションのトピックでは、ログイン、ポートの作成、ポートからクラウドプロバイダーへのVXCの作成などの一般的なタスクを実行するために必要なAPI呼び出しについて説明します。

これらのトピック以外に、次のURLで完全なAPI参照を表示できます。 https://dev.megaport.com

また、いくつかの概要動画を見ることから始めることもできます。

ビデオを再生   Megaport APIの概要については、8分の動画をご覧ください。
この動画には、Megaport Portalへのログインのウォークスルーが含まれ、 価格表やLOAなどのドキュメントを取得し、PostmanでAPIを使用します。

ビデオを再生   APIを使用してポートとVXCを注文する方法についての8分の動画をご覧ください。

環境

APIには2つのサーバー環境があります。

  • 本番環境: https://api.megaport.com
    このシステムで注文されたサービスおよび関連費用は、お客様の負担となります。

    https://api.megaport.comによるAPI変更は、Portal(ポータル)に反映されます。

  • ステージング(テスト)環境: https://api-staging.megaport.com
    このステージング環境で任意のアクションをテストでき、API呼び出しと応答は本番システムを反映しますが、サービスは構築されず、アクティビティの料金は請求されません。

    ステージングポータルアカウントは、作成されたステージングサービスを反映しています。ただし、これらは24時間ごとにリセットされます。

    本番認証情報を使用して、ステージング環境にログインし、サービスを注文または編集できます。(新規ユーザーアカウントは、ステージングで使用できるようになるまでに24時間かかります。)

    https://api-staging.megaport.comでのAPI変更は、Staging Portal(ステージングポータル)に反映されます。

注意

APIトピックの依頼は、{baseUrl}変数を使用します。設定をテストするか、本番環境で作業するかに応じて、これをステージングURL(https://api-staging.megaport.com)または本番URL(https://api.megaport.com)に置き換えることができます。Postmanコレクション(次のセクションで説明)を使用する場合は、コレクションに環境変数を定義して、API依頼にbaseUrl値を自動的に入力し、ステージング環境と本番環境を簡単に切り替えることができます。

APIとPostmanの使用の開始

Megaport APIを呼び出すためにクライアント側のコードを記述して構築するときは、JavaからPythonまで任意の言語を使用できます。

これらのAPIトピックのチュートリアルをステップスルーするには、インポートされたMegaportコレクションを備えたPostmanクライアントをお勧めします。

Postmanは、APIの構築、テスト、および変更を支援する、単純で強力なHTTPクライアントです。これを使用して、任意のAPIの任意の機能と対話できます。Postmanコレクションは、フォルダに整理された構築済みの依頼のセットであり、簡単にエクスポートして他のユーザーと共有できます。

PostmanでMegaportコレクションを使い始める前に、Megaportアカウントが必要であり、Postmanをインストールする必要があります。

PostmanでMegaportコレクションを設定するには:

  • dev.megaport.comからpostman APIコレクションをダウンロードします。
    リンク先ページの右上隅にある「Run In Postman(Postmanで実行)」ボタンをクリックします。

最後の更新: