Megaport-API

Megaport bietet eine öffentliche API für den Zugriff auf Dienste, die über das Megaport Portal verfügbar sind. Sie können diese API verwenden, um Ihre Megaport-Bereitstellung zu automatisieren und so Zeit und Aufwand zu sparen.

Die Megaport-API basiert auf REST. Die API hat vorhersehbare URLs, akzeptiert formularcodierte Anfragetexte, gibt JSON-codierte Antworten zurück und verwendet Standard-HTTP-Antwortcodes.

Die Themen in diesem Abschnitt führen Sie schrittweise durch die API-Aufrufe, die zur Durchführung gängiger Aufgaben wie Anmelden, Erstellen eines Ports und Erstellen eines VXC vom Port zu einem Cloudanbieter erforderlich sind.

Über diese Themen hinaus finden Sie eine vollständige API-Referenz unter https://dev.megaport.com.

Sie können auch damit beginnen, sich einige Übersichtsvideos anzusehen:

Video abspielen   8-minütiges Video zur Einführung in die Megaport-API
In diesem Video werden die Anmeldung beim Megaport Portal, die Beschaffung von Unterlagen wie Preislisten und LOAs sowie die Nutzung der API in Postman vorgeführt.

Video abspielen   8-minütiges Video zur Verwendung der API für die Bestellung eines Ports und eines VXC.

Umgebungen

Es gibt zwei Serverumgebungen für die APIs:

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

  • Die Testumgebung (Staging): https://api-staging.megaport.com
    Sie können jede Aktion in dieser Testumgebung testen. Dabei spiegeln die API-Aufrufe und -Antworten das Produktionssystem wider, aber die Dienste werden nicht bereitgestellt, und es werden Ihnen keine Aktivitäten in Rechnung gestellt.

    Ihr Testportalzugang enthält die von Ihnen erstellten Dienste. Diese werden jedoch alle 24 Stunden zurückgesetzt.

    Sie können die Anmeldeinformationen für die Produktionsumgebung verwenden, um sich bei der Testumgebung anzumelden und Dienste zu bestellen oder zu bearbeiten. (Neue Benutzerkonten benötigen 24 Stunden, bevor sie für die Verwendung in der Testumgebung verfügbar sind).

Hinweis

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

Erste Schritte mit der API und Postman

Wenn Sie Ihren clientseitigen Code zum Aufrufen der Megaport-API schreiben und bereitstellen, können Sie jede beliebige Sprache von Java bis Python verwenden.

Um die Tutorials unter diesen API-Themen durchzuarbeiten, empfehlen wir den Postman-Client mit der importierten Megaport-Sammlung.

Postman ist ein unkomplizierter, leistungsfähiger HTTP-Client, der das Erstellen, Testen und Ändern von APIs unterstützt. Sie können Postman verwenden, um mit jeder Funktionalität auf jeder API zu interagieren. Postman-Sammlungen sind einfach eine Reihe von vordefinierten Anfragen, die in Ordnern organisiert sind und auf einfache Weise exportiert und mit anderen geteilt werden können.

Bevor Sie die Megaport-Sammlung in Postman verwenden können, müssen Sie ein Megaport-Konto erstellen und Postman installieren.

So richten Sie die Megaport-Sammlung in Postman ein:

  • Laden Sie die Postman-API-Sammlung von dev.megaport.com herunter.
    Klicken Sie in der rechten oberen Ecke der verlinkten Seite auf die Schaltfläche Run In Postman (In Postman ausführen).

Letztes Update: