Megaport API 概要

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

Megaport API は REST に基づいています。この API は予測可能な URL を持ち、フォームエンコードされたリクエストボディを受け付け、JSON エンコーディングされたレスポンスを返し、標準的な HTTP レスポンスコードを使用します。

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

これらのトピック以外に、完全な API リファレンスを https://dev.megaport.com で表示できます。

注記

新しい機能をリリースする際には、API のバージョンを更新、変更、または非推奨にすることがあります。これらの変更を常に最新の状態に保ち、必要に応じて API 統合の更新を計画することをお勧めします。詳細については、API 非推奨通知とよくある質問 (FAQs) を参照してください。

環境

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

本番環境 – https://api.megaport.com
このシステムでのサービスおよび関連コストの注文はユーザーの責任となります。

https://api.megaport.com での API 変更は Megaport Portal に反映されます。
ステージング (テスト) 環境 – https://api-staging.megaport.com
このステージング環境であらゆるアクションをテストすることができ、API コールおよびレスポンスは本番システムを反映しますが、サービスはデプロイされず、いかなる活動も請求されません。

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

プロダクション用の認証情報を使用してステージング環境にログインし、サービスを注文または編集することができます。(新しいユーザーアカウントはステージングで利用可能になるまでに24時間かかります。)

https://api-staging.megaport.com での API 変更はステージング 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 ボタンをクリックします。