Créer un Port avec l’API
Ce sujet décrit la procédure API pour créer un Port, y compris comment rechercher les emplacements des Ports, valider le Port et déterminer le coût, commander le Port et télécharger la Lettre d’Autorisation (LOA)Une Lettre d’Autorisation (LOA) est un document que les clients doivent présenter à leur fournisseur de centre de données pour établir le cross-connect physique entre leurs services de centre de données et leur Port. La LOA est fournie via le Megaport Portal lorsqu’un client provisionne un nouveau Port.
.
Avant de commencer, obtenez un jeton d’accès valide. Pour plus d’informations, consultez Création d’une clé API.
Pour rechercher les détails de localisation d’un Port dans la collection Postman
-
Cliquez sur Locations dans la navigation de gauche, puis sur GET Locations (v3).
Cette requête n’attend pas d’information dans les Paramètres ou le Corps. -
Cliquez sur Send pour envoyer la requête.
GET {baseUrl}/v3/locations
Assurez-vous que la requête a réussi en recherchant Status: 200 OK et affichez la réponse dans la section Body au format Pretty.
La requête retourne des centaines d’emplacements de Ports. Vous pouvez rechercher en cliquant sur la loupe et en entrant une ville spécifique, un centre de données ou un autre paramètre dans le champ de recherche. Cet exemple utilise l’emplacement Digital Realty, Londres.
{
"id": 89,
"name": "Digital Realty London LHR20",
"address": {
"street": "227 Marsh Wall",
"suburb": null,
"city": "London",
"state": null,
"postcode": "E14 9SD",
"country": "United Kingdom"
},
"dataCentre": {
"id": 3,
"name": "Digital Realty"
},
"metro": "London",
"market": "UK",
"status": "Active",
"longitude": -0.012144,
"latitude": 51.499714,
"orderingMessage": null,
"diversityZones": {
"red": {
"mcrSpeedMbps": [
5000,
100000,
1000,
25000,
10000,
2500,
50000
],
"megaportSpeedMbps": [
100000,
10000,
1000
],
"mveMaxCpuCoreCount": null,
"mveAvailable": true
},
"blue": {
"mcrSpeedMbps": [
1000,
2500,
5000,
10000
],
"megaportSpeedMbps": [
1000,
10000,
100000
],
"mveMaxCpuCoreCount": null,
"mveAvailable": true
}
},
"productAddOns": {
"crossConnect": {
"available": false,
"type": null
}
}
}
Pour créer un Port, vous avez besoin de la valeur market et de la valeur id. Dans cet exemple, le marché est UK et l’identifiant du centre de données est 89.
Pour tester et valider la commande de Port
-
Dans Postman, ouvrez le dossier Ports dans la navigation de gauche et sélectionnez POST Validate Port Order (v3).
-
Mettez à jour le corps (Body) avec le
locationId(89), leterm(nombre de mois – 1, 12, 24 ou 36), leproductName(le nom que vous souhaitez donner à votre Port), leportSpeed(1000, 10000 ou 100000 Mbps), et lemarket(UK), puis cliquez sur Send.
[
{
"locationId": 89,
"term": 1,
"locationUid": null,
"productName": "API Port",
"productType": "MEGAPORT",
"createDate": 1452475039656,
"portSpeed": 1000,
"virtual": false,
"promoCode": "promox3mnthfree2",
"market": "UK"
}
]
Une réponse réussie passe la validation et renvoie un statut 200 OK. La réponse inclut également les détails de tarification du service.
{
"message": "Validation passed",
"terms": "These data are subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": [
{
"price": {
"hourlySetup": 0,
"dailySetup": 0,
"monthlySetup": 0,
"hourlyRate": 0,
"dailyRate": 0,
"monthlyRate": 500.00,
"fixedRecurringCharge": 500.00,
"postPaidBaseRate": "no base rate",
"longHaulMbpsRate": 0,
"mbpsRate": 0,
"currency": "GBP",
"key": "no key",
"productType": "MEGAPORT",
"empty": false
},
"serviceName": "API Port",
"productType": "MEGAPORT",
"productUid": "f9859fd3-344d-4a33-8cd2-a3b6ebfaaef0",
"market": "UK",
"string": "London"
}
]
}
Pour commander le Port validé
-
Avec une demande de Port validée et des informations de coût examinées, copiez le Corps de POST Validate Port Order (v3) et collez-le dans le Corps de POST Buy Port (v3).
Important
Si vous effectuez cet appel sur api.megaport.com, votre compte sera facturé pour le service. Sinon, vous pouvez provisionner contre l’API de staging sans frais, comme dans ces exemples.
-
Envoyez la requête.
Une réponse réussie inclut untechnicalServiceUid, qui est le même que leproductUid.
Pour notre exemple, cette valeur est a49cf3f1-20a1-4390-93aa-5005bdafe3d7.
{
"message": "MEGAPORT [a49cf3f1-20a1-4390-93aa-5005bdafe3d7] created. ",
"terms": "These data are subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": [
{
"serviceName": "API Port",
"name": "API Port",
"secondaryName": null,
"technicalServiceId": 68124,
"technicalServiceUid": "a49cf3f1-20a1-4390-93aa-5005bdafe3d7",
"requestedDate": 1588862976322,
"configuredDate": null,
"currentEstimatedDelivery": null,
"companyName": "Megaport Lab",
"companyId": 2278,
"aggregationId": null,
"lagPrimary": false,
"billingContactName": null,
"billingContactId": null,
"adminContactName": null,
"adminContactId": null,
"technicalContactName": null,
"technicalContactId": null,
"salesName": null,
"salesId": null,
"billableId": 56333,
"billableUsageAlgorithm": "NOT_POST_PAID",
"productType": "MEGAPORT",
"provisioningStatus": "DEPLOYABLE",
"inAdvanceBillingStatus": "NOT_ACTIVATED",
"provisioningItems": [],
"tags": [],
"vxcDistanceBand": null,
"intercapPath": null,
"marketplaceVisibility": true,
"vxcPermitted": true,
"vxcAutoApproval": false,
"createDate": 1588862976322,
"terminationDate": null,
"contractStartDate": 1588860000000,
"contractTermMonths": 1,
"rateType": "MONTHLY",
"trialAgreement": false,
"payerCompanyId": null,
"nonPayerCompanyId": null,
"minimumSpeed": null,
"maximumSpeed": null,
"rateLimit": 10000,
"errorMessage": null,
"market": "UK",
"accountManager": null,
"promptUid": null,
"components": [],
"attributes": [],
"aLocation": null,
"bLocation": null,
"aLocationId": null,
"bLocationId": null,
"attributeTags": {},
"createdBy": "a51cc1c6-95a0-48c7-a5a0-e49d77a6c536",
"buyoutPort": false,
"virtual": false,
"locked": false,
"adminLocked": false
}
]
}
Le nouveau Port apparaît maintenant dans votre environnement de travail, soit portal.megaport.com, soit portal-staging.megaport.com.
Conseil
Pour voir toutes les options pour les requêtes utilisées dans cet exemple, consultez https://dev.megaport.com.
Télécharger la Lettre d’Autorisation (LOA)
Après avoir créé votre Port, vous pouvez télécharger la LOA.
Remarque
Avant de pouvoir télécharger la LOA, le statut de Provisioning du Port doit être Configuré.
Pour télécharger la LOA
-
Dans Postman, développez Ports dans la navigation de gauche et sélectionnez GET Regenerate LOA for Megaport Service.
-
Dans la commande GET, remplacez le
productIDpar la valeur créée lors de la création du Port. -
Envoyez la requête.
Avec une réponse réussie 200 OK, ce message apparaît dans la section Body:
This response could not be previewed. Download the response to open it with an appropriate application.Ce message apparaît puisque la LOA est un document PDF et doit être téléchargé. Pour télécharger, cliquez sur Save Response dans Postman et enregistrez le PDF à un emplacement convenable.