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 Dienstschlüssels

Erstellen eines Service Keys mit der API

Dieses Thema beschreibt das API-Verfahren zum Erstellen eines Service Keys, einschließlich der Ermittlung der Port-ID (productUid) und der Erstellung einer VXC mit einem Service Key.

Eine Übersicht über Service Keys finden Sie unter Einrichten von Service Keys und Verwalten von Service Keys. Weitere Informationen zu Service-Key-APIs finden Sie unter Service Keys (API Documentation).

Voraussetzungen

Zugriff auf das Megaport Portal.
Einen Port, MCR, oder MVE im Megaport Netzwerk.
Sie haben ein gültiges Access Token. Weitere Informationen finden Sie unter Erstellen eines API-Schlüssels.

So erhalten Sie die productUid für den Port

In Postman klicken Sie in der linken Navigation auf Produktdetails und wählen GET Produktliste aus.
Klicken Sie auf Senden.
Ermitteln Sie in den zurückgegebenen Produktdetails den Wert von productUid für den Port, für den Sie den Service Key erstellen möchten.

Dieses Beispiel verwendet den folgenden Port:
```
"productName": "CoreSite LA1" in "city": "Los Angeles" 
mit "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
```

Erstellen eines Service Keys

Nachdem Sie den productUid-Wert für das Produkt gefunden haben, für das Sie den Service Key erstellen möchten, können Sie die Megaport API verwenden, um den Service Key zu erstellen.

So erstellen Sie einen Service Key

In Postman klicken Sie in der linken Navigation auf Verbindungen und wählen Service Keys > POST Service Key generieren aus.

Kopieren Sie die productUid Ihrer On-Ramp (Port) und aktualisieren Sie den Body.

In diesem Beispiel beträgt der Wert der productUid des Ports 8611b645-ea50-46eb-b400-1c2fb858a303.

{
    "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303",
    "description": "Documentation Service Key - Single Use",
    "active": true,
    "_set_singleUse_to_false_to_make_service_key_multiUse": true,
    "singleUse": true,
    "maxSpeed": "500",
    "preApproved": true,
    "vlan": 3,
    "validFor": {
         "_make_start_timestamp_equal_to_now": 1608506197135,
         "start": 1608506197135,
         "_make_end_timestamp_equal_to_1_month_forward": 1612015200000,
         "end": 1612015200000
    }
}

Geben Sie zusätzliche Parameter im Body an, z. B. die Ratenbegrenzung (maxSpeed), wie lange der Schlüssel gültig ist (validFor) und ob Sie einen Einmal-Schlüssel ("singleUse": true) oder einen Mehrfach-Schlüssel ("singleUse": false) benötigen. Die Datumsangaben werden im UNIX-Timestamp-Format eingegeben. Sie können Tools wie https://www.epochconverter.com/ oder https://it-tools.tech/date-converter verwenden, um den korrekten Wert zu ermitteln.

Nur für Einmal-Schlüssel geben Sie eine VLAN-ID (vlan) an.

Dies ist die VLAN-ID für das B-Ende. Megaport prüft, ob die angeforderte VLAN-ID verfügbar ist. Wenn ein Kunde diesen Service Key verwendet, um eine Verbindung zu Ihrem Port herzustellen, kann er eine VLAN-ID für das A-Ende angeben.

Weitere Informationen zu VLAN-IDs finden Sie unter Verwalten von VLAN-IDs.
Wenn Sie fertig sind, klicken Sie auf Senden, um die Anfrage zu senden.
```
POST /v2/service/key
```

Eine erfolgreiche Antwort hat den HTTP-Status 200 OK.

{
    "message": "New service key [106e38ae-eb59-415f-ac81-526a5299851d] generated",
    "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
    "data": {
        "key": "106e38ae-eb59-415f-ac81-526a5299851d",
        "createDate": 1712277262872,
        "companyId": 1153,
        "companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
        "companyName": "Megaport Lab",
        "description": "Documentation Service Key - Single Use",
        "productId": 193076,
        "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303",
        "productName": "My new Port",
        "vlan": 3,
        "maxSpeed": 500,
        "preApproved": true,
        "singleUse": true,
        "lastUsed": null,
        "active": true,
        "validFor": {
            "start": 1608506197135,
            "end": 1612015200000
        },
        "expired": true,
        "valid": false,
        "promoCode": null,
        "productDto": {
            "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303",
            "productName": "My new Port",
            "portSpeed": 1000,
            "locationId": 60,
            "vxcPermitted": true,
            "companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
            "companyName": "Megaport Lab",
            "connectType": "DEFAULT",
            "productId": 193076,
            "productType": "MEGAPORT",
            "provisioningStatus": "LIVE",
            "createDate": 1712268634020,
            "createdBy": "0b367492-186d-47ab-96e0-34ca03d29dcd",
            "terminateDate": null,
            "liveDate": 1712268694790,
            "market": "US",
            "costCentre": "Optional finance reference",
            "usageAlgorithm": "NOT_POST_PAID",
            "marketplaceVisibility": false,
            "secondaryName": null,
            "lagPrimary": false,
            "lagId": null,
            "aggregationId": null,
            "contractStartDate": 1712268694807,
            "contractEndDate": 1714831200000,
            "contractTermMonths": 1,
            "associatedVxcs": [],
            "associatedIxs": [],
            "attributeTags": {},
            "virtual": false,
            "buyoutPort": false,
            "locked": false,
            "adminLocked": false,
            "diversityZone": null,
            "nserviceId": 521477,
            "cancelable": true
        }
    }
}

Der neue Service Key erscheint nun im Megaport Portal.

Bearbeiten oder Deaktivieren des Schlüssels

Sie können die Details eines Service Keys bearbeiten oder ihn dauerhaft deaktivieren.

So bearbeiten oder deaktivieren Sie den Service Key:

In Postman öffnen Sie den Ordner Verbindungen in der linken Navigation und wählen Service Keys > PUT Service Key aktualisieren aus.
Bearbeiten Sie die Details des Service Keys nach Bedarf.
Um den Service Key dauerhaft zu deaktivieren, setzen Sie den Parameter active auf false.

Schlüssel teilen

Sie können den Service Key auf beliebige Weise teilen, zum Beispiel per E-Mail oder Messaging.

Hinweis

Der Empfänger des Service Keys kann die Parameter des Service Keys nicht ändern oder modifizieren.

Erstellen eines VXC mit einem Service Key

Nachdem Sie einen Service Key erhalten haben, können Sie mit dem Service Key ein VXC erstellen, das das im Service Key definierte A-Ende und Ihr B-Ende verbindet.

So erstellen Sie ein VXC mit einem Service Key:

Öffnen Sie in Postman den Ordner Verbindungen in der linken Navigation und wählen Sie Service Keys > POST VXC mit Service Key erstellen aus.
Geben Sie die Konfigurationsdetails im Body der Anfrage an.
- productUid - Geben Sie die productUid des Ports an Ihrem Megaport-Standort ein.
- bEnd: productUid - Geben Sie die productUid des B-Ends aus der Service-Key-Abfrage an.
- serviceKey - Geben Sie den vollständigen Service Key ein.
- ratelimit - Geben Sie eine ratelimit bis zum maximal im Service Key festgelegten Ratenlimit an.
- term - Geben Sie die Vertragslaufzeit für das VXC an. Gültige Werte sind 1, 12, 24 und 36 Monate. Wenn Sie beim Bestellen kein term angeben, wird standardmäßig 1 (kein Mindestlaufzeit) verwendet.
- shutdown - Sie können das VXC vorübergehend herunterfahren und wieder aktivieren. Zulässige Werte sind true (heruntergefahren) und false (aktiviert). Wird kein Wert angegeben, ist der Standard false (aktiviert).
- promoCode - Sie können einen Promotion-Code für die Service-Bestellung eingeben. Der Code wird nicht validiert; wenn der Code nicht existiert oder nicht für den Dienst gilt, schlägt das Bestellen trotzdem nicht fehl.
- vlan - (Optional) Bevorzugte VLAN-ID für das A-Ende. Geben Sie eine freie VLAN-ID für diese Verbindung an.
  
  Diese VLAN-ID muss auf diesem Port eindeutig sein und darf im Bereich 2 bis 4093 liegen. Wenn Sie eine VLAN-ID angeben, die bereits verwendet wird, zeigt das System die nächste verfügbare VLAN-Nummer an. Die VLAN-ID muss eindeutig sein, damit die Bestellung fortgesetzt werden kann. Wenn Sie keinen Wert angeben, weist Megaport automatisch eine zu.
  
  Die VLAN-ID für das B-Ende (Provider-Seite) wird automatisch aus dem Service Key übernommen.
```
{
    "productUid": "7fba50bb-ac35-465b-9b8b-9a6d7335ec7a",
    "associatedVxcs": [
        {
            "productName": "VXC from service key",
            "rateLimit": 100,
            "term": 12,
            "shutdown": false,
            "promoCode": "promox3mnthfree2",
            "serviceKey": "106e38ae-eb59-415f-ac81-526a5299851d",
            "aEnd": {
                "vlan": 2
            },
            "bEnd": {
                "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
            }
        }
    ]
}
```
Wenn Sie fertig sind, klicken Sie auf Senden, um die Anfrage zu senden.
```
POST /v3/networkdesign/buy
```
Tipp

Um Ihre Anfrage vor der Bestellung zu testen und Preisinformationen zu sehen, verwenden Sie den Endpunkt /v3/networkdesign/validate mit derselben Body-Konfiguration.

Eine erfolgreiche Antwort besteht die Validierung und hat den Status 200 OK.

{
  "message": "VXC [399f0fd8-8a69-4e15-abdb-537b0cb8a858] created. ",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
  "data": [
    {
      "createDate": 1610140443499,
      "vxcOrderId": 55791,
      "payerMegaPortId": 74841,
      "nonPayerMegaPortId": 39950,
      "payerMegaPortName": "My LA API Port",
      "nonPayerMegaPortName": "BNE5-01-10G",
      "payerCompanyId": 15,
      "nonPayerCompanyId": 28,
      "payerLocationId": 60,
      "nonPayerLocationId": 44,
      "salesId": null,
      "payerCompanyName": "Megaport Lab",
      "nonPayerCompanyName": "6YS",
      "payerMegaPortNsId": 167551,
      "nonPayerMegaPortNsId": 90147,
      "payerVlanId": 2,
      "nonPayerVlanId": 373,
      "payerInnerVlanId": null,
      "nonPayerInnerVlanId": null,
      "payerApproverName": "Test Name",
      "payerApproverId": 32278,
      "nonPayerApproverName": null,
      "nonPayerApproverId": null,
      "payerApproval": 1610140443263,
      "nonPayerApproval": 1610140443308,
      "fixedTerm": true,
      "duration": 1,
      "rollover": true,
      "serviceName": "from My LA API Port to BNE5-01-10G",
      "payerStatus": "APPROVED",
      "nonPayerStatus": "APPROVED",
      "speed": 100,
      "distanceBand": "ZONE",
      "intercapPath": "",
      "awsId": null,
      "promoCode": null,
      "rateType": "MONTHLY",
      "vxcJTechnicalServiceId": 74842,
      "vxcJTechnicalServiceUid": "399f0fd8-8a69-4e15-abdb-537b0cb8a858",
      "provisionDate": 1610140443232,
      "orderType": "NEW",
      "monthlyDiscountAmount": null,
      "discountMonths": null,
      "amazonDirectConnectConfigDto": null,
      "amsixConnectConfigDto": null,
      "webAirProvItem": null,
      "sdrcProvItem": null,
      "rate": null,
      "setup": null,
      "asn": null,
      "bgpPassword": null,
      "usageAlgorithm": "POST_PAID_HOURLY_SPEED_LONG_HAUL_VXC",
      "costCentre": null,
      "azureServiceKey": null,
      "oracleVirtualCircuitId": null,
      "serviceKey": "106e38ae-eb59-415f-ac81-526a5299851d",
      "connectType": "DEFAULT",
      "payerConfig": {},
      "nonPayerConfig": {},
      "attributeTags": {},
      "fullyApproved": true
    }
  ]
}

Nach der Bestellung der Service-Key-VXC wird eine Benachrichtigung an das Unternehmen gesendet, mit dem Sie sich verbinden. Das empfangende Unternehmen kann den Schlüssel entweder akzeptieren oder ablehnen. Es kann den Schlüssel nicht ändern, kann jedoch vor der Annahme Änderungen an den Parametern des Service Keys anfordern.

Die Service-Key-VXC wird im Megaport Portal für beide Unternehmen angezeigt.