Megaport API-Übersicht

Megaport bietet eine öffentliche API für den Zugriff auf alle über das Megaport Portal verfügbaren Services. Mit dieser API können Sie Ihre Megaport-Bereitstellung automatisieren, um Zeit und Aufwand zu sparen.

Die Megaport API basiert auf REST. Die API hat vorhersehbare URLs, akzeptiert form-urlencoded Request-Bodies, liefert JSON-codierte Antworten und verwendet standardmäßige HTTP-Antwortcodes.

Die Themen in diesem Abschnitt führen Sie durch die API-Aufrufe, die für gängige Aufgaben erforderlich sind, z. B. die Anmeldung, das Erstellen eines Ports und das Erstellen eines VXC vom Port zu einem Cloud-Provider.

Darüber hinaus können Sie eine vollständige API-Referenz unter https://dev.megaport.com einsehen.

Hinweis

Von Zeit zu Zeit aktualisieren wir APIs, ändern Versionen und kündigen APIs ab, wenn wir neue Funktionen veröffentlichen. Wir empfehlen, über diese Änderungen auf dem Laufenden zu bleiben und entsprechende Aktualisierungen Ihrer API-Integration einzuplanen. Weitere Informationen finden Sie unter Hinweise zur API-Abkündigung und häufig gestellte Fragen (FAQs).

Umgebungen

Für die APIs gibt es zwei Serverumgebungen:

Produktionsumgebung – https://api.megaport.com
Sie sind für alle in diesem System bestellten Services und die damit verbundenen Kosten verantwortlich.

API-Änderungen über https://api.megaport.com werden im Megaport Portal widergespiegelt.
Staging (Test) Umgebung – https://api-staging.megaport.com
In dieser Staging-Umgebung können Sie beliebige Aktionen testen; die API-Aufrufe und -Antworten spiegeln das Produktionssystem, jedoch werden keine Services bereitgestellt und Ihnen werden keine Aktivitäten in Rechnung gestellt.

Ihr Staging-Portal-Konto zeigt die erstellten Staging-Services an; diese werden jedoch alle 24 Stunden zurückgesetzt.

Sie können Ihre Produktionsanmeldedaten verwenden, um sich bei der Staging-Umgebung anzumelden und Services zu bestellen oder zu bearbeiten. (Neue Benutzerkonten benötigen 24 Stunden, bevor sie in Staging verwendet werden können.)

API-Änderungen über https://api-staging.megaport.com werden im Staging Portal widergespiegelt.

Hinweis

Die Anfragen in den API-Themen verwenden die Variable {baseUrl}. Sie können diese durch die Staging-URL (https://api-staging.megaport.com) oder die Produktions-URL (https://api.megaport.com) ersetzen, je nachdem, ob Sie Konfigurationen testen oder mit Ihrer Produktionsbereitstellung arbeiten möchten. Wenn Sie die Postman Collection (im nächsten Abschnitt beschrieben) verwenden, können Sie in der Collection Umgebungsvariablen definieren, um den baseUrl-Wert in API-Requests automatisch zu befüllen und einfach zwischen Staging- und Produktionsumgebungen zu wechseln.

Erste Schritte mit der API und Postman

Beim Schreiben und Bereitstellen Ihres Client-seitigen Codes zum Aufrufen der Megaport API können Sie jede bevorzugte Sprache verwenden, von Java bis Python.

Zum Durcharbeiten der Tutorials in diesen API-Themen empfehlen wir den Postman-Client mit der importierten Megaport Collection.

Postman ist ein unkomplizierter, leistungsstarker HTTP-Client, mit dem Sie APIs erstellen, testen und ändern können. Sie können ihn verwenden, um mit beliebigen Funktionen jeder API zu interagieren. Postman Collections sind einfach eine Reihe vorgefertigter Requests, die in Ordnern organisiert sind, und können leicht exportiert und mit anderen geteilt werden.

Bevor Sie mit der Megaport Collection in Postman beginnen können, benötigen Sie ein Megaport-Konto und müssen Postman installieren (https://www.postman.com/downloads/).

So richten Sie die Megaport Collection in Postman ein

Laden Sie die Postman-API-Collection von dev.megaport.com herunter.
Klicken Sie oben rechts auf der Seite auf die Schaltfläche In Postman ausführen.