API API API API API API API API API API API API API API API API API API API API API API API Création d’une clé de service

Création d’une clé de service avec l’API

Ce sujet décrit la procédure API pour créer une clé de service, y compris comment obtenir l’ID du Port (productUid) et créer une VXC avec une clé de service.

Pour un aperçu des clés de service, voir Configuration des clés de service et Gestion des clés de service. Pour plus d’informations sur les API des clés de service, voir Clés de service (Documentation API).

Prérequis

Accès au Megaport Portal.
Un Port, MCR, ou MVE sur le réseau Megaport.
Vous avez un jeton d’accès valide. Pour plus d’informations, voir Création d’une clé API.

Pour obtenir le productUid du Port

Dans Postman, cliquez sur Product Details dans la navigation de gauche et sélectionnez GET Product List.
Cliquez sur Send.
À partir des détails du produit retournés, localisez la valeur productUid pour le Port pour lequel vous souhaitez créer la clé de service.

Cet exemple utilise le Port suivant:
```
"productName": "CoreSite LA1" dans "city": "Los Angeles"
avec "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
```

Création d’une clé de service

Après avoir localisé la valeur productUid pour le produit pour lequel vous souhaitez créer la clé de service, vous pouvez utiliser l’API Megaport pour créer la clé de service.

Pour créer une clé de service

Dans Postman, cliquez sur Connections dans la navigation de gauche et sélectionnez Service Keys > POST Generate Service Key.

Copiez le productUid de votre on-ramp (Port) et mettez à jour le Body.

Pour cet exemple, la valeur du productUid du Port est 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
    }
}

Spécifiez des paramètres supplémentaires dans le corps (Body), par exemple, la limite de débit (maxSpeed), la durée de validité de la clé (validFor), et si vous avez besoin d’une clé à usage unique ("singleUse": true) ou d’une clé à usages multiples ("singleUse": false). Les dates sont saisies au format timestamp UNIX. Vous pouvez utiliser des outils tels que
https://www.epochconverter.com/ ou https://it-tools.tech/date-converter pour déterminer la valeur correcte à entrer.

Pour les clés à usage unique uniquement, spécifiez un ID VLAN (vlan).

Il s’agit de l’ID VLAN pour le B-End. Megaport vérifie que l’ID VLAN demandé est disponible. Lorsqu’un client utilise cette clé de service pour créer une connexion vers votre Port, il peut spécifier un ID VLAN pour le A-End.

Pour plus d’informations sur les ID VLAN, consultez Gestion des IDs VLAN.
Une fois terminé, cliquez sur Send pour envoyer la requête.
```
POST /v2/service/key
```

Une réponse réussie passe la validation et renvoie un statut 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
        }
    }
}

La nouvelle clé de service apparaît maintenant dans le Megaport Portal.

Modifier ou désactiver la clé

Vous pouvez modifier les détails d’une clé de service ou la désactiver définitivement.

Plusieurs raisons peuvent vous amener à désactiver la clé. Par exemple, vous créez une clé de service pour l’un de vos Ports et la partagez avec votre client, mais avant que votre client ne crée une connexion avec la clé de service, le Port devient indisponible et vous souhaitez empêcher votre client d’utiliser cette clé.

Pour modifier ou désactiver la clé de service

Dans Postman, ouvrez le dossier Connections dans la navigation de gauche et sélectionnez Service Keys > PUT Update Service Key.
Modifiez les détails de la clé de service selon vos besoins.
Pour désactiver définitivement la clé de service, définissez le paramètre active sur false.

Partager la clé

Vous pouvez partager la clé de service comme vous le souhaitez, par exemple par email ou messagerie.

Remarque

Le destinataire de la clé de service ne peut pas modifier ou altérer les paramètres de la clé de service.

Créer un VXC avec une clé de service

Après avoir reçu une clé de service, vous pouvez créer un VXC avec cette clé pour connecter l’A-End on-ramp défini dans la clé de service à votre B-End on-ramp.

Pour créer un VXC avec une clé de service

Dans Postman, ouvrez le dossier Connections dans la navigation de gauche et sélectionnez Service Keys > POST Create VXC with a Service Key.
Spécifiez les détails de configuration dans le corps (Body) de la requête.
- productUid – Saisissez le productUid du Port dans votre emplacement Megaport.
- bEnd: productUid – Saisissez le productUid provenant de la recherche de clé de service.
- serviceKey – Saisissez la clé de service complète.
- ratelimit – Spécifiez un ratelimit jusqu’à la limite maximale définie sur la clé de service.
- term – Spécifiez la durée du contrat pour le VXC. Les valeurs valides sont 1, 12, 24 et 36 mois. Si vous ne spécifiez pas term lors de la commande d’un VXC, la valeur par défaut est 1 (Pas de durée minimale).
- shutdown – Vous pouvez temporairement arrêter et réactiver le VXC. Les valeurs valides sont true (arrêté) et false (activé). Si non fourni, la valeur par défaut est false (activé).
- promoCode – Vous pouvez saisir un code promotionnel pour la commande de service. Le code n’est pas validé ; si le code n’existe pas ou ne fonctionne pas pour le service, l’appel reste néanmoins réussi.
- vlan – (Optionnel) VLAN préféré A-End. Spécifiez un ID VLAN inutilisé pour cette connexion.
  
  Cet ID VLAN doit être unique sur ce Port et peut être compris entre 2 et 4093. Si vous spécifiez un ID VLAN déjà utilisé, le système affiche le numéro VLAN disponible suivant. L’ID VLAN doit être unique pour continuer la commande. Si aucune valeur n’est spécifiée, Megaport en attribuera une.
  
  Le VLAN B-End pour la terminaison côté fournisseur sera automatiquement renseigné en fonction de la clé de service.
```
{
    "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"
            }
        }
    ]
}
```
Une fois terminé, cliquez sur Send pour envoyer la requête.
```
POST /v3/networkdesign/buy
```
Conseil

Pour tester votre requête avant de passer la commande et voir les détails de tarification, utilisez le point de terminaison /v3/networkdesign/validate avec la même configuration du corps (Body).

Une réponse réussie passe la validation et renvoie un statut 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
    }
  ]
}

Après la commande de la clé de service VXC, une notification est envoyée à l’entreprise à laquelle vous vous connectez, et l’entreprise réceptrice peut soit accepter soit rejeter la clé. Ils ne peuvent pas modifier la clé mais peuvent demander des modifications des paramètres de la clé de service avant de l’accepter.

La clé de service VXC apparaîtra dans le Megaport Portal pour les deux entreprises.