API API API API API API API API API API API API API API API API API API API API API API API Erstellen eines API-Schlüssels

Erstellen eines API-Schlüssels

Megaport API-Aufrufe erfordern einen Access Token, den Sie nach dem Erstellen eines API-Schlüssels generieren können. Ein Access Token ist für die Authentifizierung von API-Benutzern erforderlich und ermöglicht temporären Zugriff nur auf die Teile des Megaport Portal, die benötigt werden.

Wir empfehlen, ein dediziertes, Machine-to-Machine (M2M), Company-Admin-Konto für den Zugriff auf die Megaport API und zum Erstellen von API-Schlüsseln zu verwenden. Falls ein menschlicher Benutzer deaktiviert wird oder den Zugriff auf sein Konto verliert, werden die von diesem Benutzer erstellten API-Schlüssel ebenfalls gesperrt, was Integrationen über die API zum Stillstand bringen kann.

API-Schlüssel sind nur in der Umgebung gültig, in der sie generiert wurden. Wenn Sie API-Schlüssel für den Zugriff auf eine andere Umgebung benötigen, melden Sie sich in der entsprechenden Umgebung beim Megaport Portal an und generieren Sie die API-Schlüssel dort.

Hinweis

Sie müssen im Megaport Portal als Company Admin angemeldet sein, um einen API-Schlüssel zu erstellen. Weitere Informationen finden Sie unter Verwalten von Benutzerrollen.
Pro Unternehmen können maximal fünf API-Schlüssel erstellt werden.

Dieses Thema beschreibt die folgenden Aufgaben:

Erstellen eines API-Schlüssels im Megaport Portal
Generieren eines Access Tokens in Postman

So erstellen Sie einen API-Schlüssel im Megaport Portal

Wählen Sie im Megaport Portal Tools > API Key Generator.
Der Bildschirm API Keys ermöglicht das Erstellen von API-Schlüsseln sowie das Anzeigen und Bearbeiten vorhandener API-Schlüssel.
Geben Sie die Details für den API-Schlüssel an.
- Name – Geben Sie einen Namen für den API-Schlüssel ein.
  Dies sollte ein beschreibender Name sein, der den Zweck des Schlüssels erkennen lässt.
  Hinweis
  - Für den Namen des API-Schlüssels sind mindestens drei Zeichen erforderlich.
  - Es sind keine Sonderzeichen erlaubt, außer Gedankenstrich und Bindestrich.
- Role – Wählen Sie die Rolle des Benutzers, der die API verwenden wird.
  Folgende Optionen sind verfügbar:
  - Company Admin
  - Read Only
- Tokenablauf (Minuten) – Geben Sie die Zeitspanne (in Minuten) an, nach der der von diesem Schlüssel generierte Token abläuft. Das Minimum beträgt 5 Minuten und das Maximum 24 Stunden (1440 Minuten). Nach Ablauf des Tokens müssen Sie einen neuen Access Token generieren.
Klicken Sie auf Generate Key.
Der API-Schlüssel wird erstellt und die Eingabeaufforderung Your API Key wird angezeigt.

Wichtig

Kopieren Sie Ihren neuen API Key und das API Key Secret und speichern Sie diese Zugangsdaten an einem sicheren Ort. Sie benötigen sie zum Generieren von Access Tokens. Stellen Sie sicher, dass Sie das API Key Secret kopieren, da es nach dem Schließen dieser Aufforderung nicht erneut angezeigt wird.
Klicken Sie rechts neben dem Feld API Key auf Copy und fügen Sie den Schlüssel (Client Id) an einem sicheren Ort ein.
Klicken Sie rechts neben dem Feld API Key Secret auf Copy und fügen Sie das Client secret an einem sicheren Ort ein.
Klicken Sie auf Schließen.
Der API-Schlüssel wird erstellt und im Bereich Active API Keys des Bildschirms angezeigt.
Im Bereich Active API Keys können Sie den Namen des Schlüssels bearbeiten, den Schlüssel löschen und den Änderungsverlauf für den Schlüssel anzeigen.

Generieren eines Access Tokens

Nachdem Sie den API-Schlüssel erstellt haben, bestehend aus Client ID und Client Secret, können Sie einen Access Token zur Authentifizierung von API-Benutzern generieren. Diese Anleitung beschreibt, wie Sie dies mit Postman und der Megaport-Collection durchführen. Details zur Postman-Einrichtung finden Sie unter Megaport API.

Welche Request-URL Sie verwenden müssen, hängt von der Umgebung ab, in der Sie einen Access Token generieren. In den jeweiligen Umgebungen sind diese Request-URLs zu verwenden:

Produktionsumgebung – https://auth-m2m.megaport.com/oauth2/token
Staging- (Test-)Umgebung – https://auth-m2m-staging.megaport.com/oauth2/token

Diese Anleitung beschreibt, wie Sie in der Produktionsumgebung einen Access Token generieren. Weitere Informationen finden Sie unter Megaport API und Megaport Authentication - API Keys.

Hinweis

Welche API-Endpoints ein Access Token aufrufen kann, hängt von der beim Erstellen des API-Schlüssels ausgewählten Rolle ab. Beispielsweise unterliegen Read Only API-Schlüssel stärkeren Einschränkungen hinsichtlich der zugänglichen Daten als Company Admin API-Schlüssel.

So generieren Sie einen Access Token in Postman

Klicken Sie in der importierten Megaport-Collection in Postman auf das Plus-Symbol, um eine neue Anfrage hinzuzufügen.
Wählen Sie in der Dropdown-Liste links neben dem Feld Request URL die Methode POST aus.
Geben Sie im Feld Request URL die folgende Request-URL ein:
https://auth-m2m.megaport.com/oauth2/token
Wählen Sie die Registerkarte Authorization und geben Sie die folgenden Parameterdetails ein:
- Username – Die Client Id, die Sie beim Erstellen des API-Schlüssels zuvor kopiert haben.
- Password – Das Client secret, das Sie beim Erstellen des API-Schlüssels zuvor kopiert haben.
Hinweis

Diese Parameter enthalten sensible Daten. Wenn Sie in einer kollaborativen Umgebung arbeiten, können Sie die Client ID und das Client secret als Variablen {{apiKeyClientId}} bzw. {{apiKeyClientSecret}} festlegen. Weitere Informationen zu Variablen finden Sie in der Postman-Dokumentation.
Wählen Sie die Registerkarte Body und geben Sie einen Schlüssel namens grant_type mit dem Wert client_credentials ein.
Klicken Sie auf Speichern.
Der Bildschirm Save Request wird angezeigt.
Geben Sie im Feld Request name einen aussagekräftigen Namen für die neue Anfrage ein.
Zum Beispiel Generate Access Token.
(Optional) Geben Sie eine Beschreibung der Anfrage ein.
Wählen Sie, wo Sie die Anfrage speichern möchten, und klicken Sie dann auf Speichern.
Die neue Anfrage wird erstellt und zur Megaport API Documentation-Collection hinzugefügt.
Klicken Sie auf Senden.

Sie sollten eine Antwort erhalten, die Ihren Access Token enthält, ähnlich dem folgenden Beispiel. Sobald ein Access Token generiert wurde, kann er zur Authentifizierung von API-Benutzern für verschiedene Endpunkte im Megaport Portal verwendet werden.
```
 {
  "access_token":  
      "eyJraWQ......2cOQGA",
  "expires_in": 86400,
  "token_type": "Bearer"
 }
```
Kopieren Sie den Access Token.
Fügen Sie in den Variablen der Collection (klicken Sie auf die drei Punkte neben der importierten Megaport-Collection > Edit > Variables) einen Eintrag für access_token hinzu und fügen Sie den Access Token in das Feld CURRENT VALUE ein.
Für jeden API-Aufruf, den Sie senden möchten, sollte auf der Registerkarte Authorization der Type auf Bearer Token und der Token auf die Access-Token-Variable {{access_token}} gesetzt sein.

Der API-Aufruf ist nun einsatzbereit. Alle API-Aufrufe erfolgen über SSL/TLS und jeder Aufruf wird für entsprechende Berechtigungen gegen den Access Token validiert.

Hinweis

Access Tokens laufen ab, daher müssen Sie regelmäßig neue Tokens für Ihre API-Aufrufe generieren. Die Ablaufdauer wird durch den Wert bestimmt, der beim Erstellen des API-Schlüssels für das Feld Tokenablauf (Minuten) eingegeben wurde. Die standardmäßige Ablaufdauer beträgt 24 Stunden.

API-Anfragen enthalten zwei wichtige Header-Parameter: Authorization und Content-Type. Der Parameter Authorization verweist auf die Registerkarte Authorization, auf der die Token-Variable gesetzt ist.

Erforderliche Header

cURL-Token-Generierung

Eine weitere Möglichkeit, einen Access Token zu generieren, ist die Verwendung von cURL in einer Befehlskonsole im folgenden Format:

 curl -X "POST" "https://auth-m2m.megaport.com/oauth2/token" \
        -H 'Content-Type: application/x-www-form-urlencoded' \
        -u '<api_key>:<api_key_secret>' \
        --data-urlencode "grant_type=client_credentials"

Tipp

Die Website dev.megaport.com zeigt jeden API-Endpunkt in mehreren Programmiersprachen an.