API API API API API API API API API API API API API API API API API API API API API API API Crear una clave de servicio

Creación de una clave de servicio con la API

Este tema describe el procedimiento de API para crear una clave de servicio, incluido cómo obtener el ID del Port (productUid) y crear un VXC con una clave de servicio.

Para una descripción general de las claves de servicio, consulte Configuración de claves de servicio y Administración de claves de servicio. Para obtener más información sobre las API de claves de servicio, consulte Claves de servicio (Documentación de la API).

Requisitos previos

Acceso al Megaport Portal.
Un Port, MCR, o MVE en la red de Megaport.
Tiene un token de acceso válido. Para obtener más información, consulte Creación de una clave de API.

Para obtener el productUid del Port

En Postman, haga clic en Product Details (Detalles del producto) en la navegación izquierda y seleccione GET Product List (GET Lista de productos).
Haga clic en Send (Enviar).
A partir de los detalles del producto devueltos, localice el valor de productUid del Port para el cual desea crear la clave de servicio.

Este ejemplo utiliza el siguiente Port:
```
"productName": "CoreSite LA1" en "city": "Los Angeles" 
con "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
```

Creación de una clave de servicio

Después de localizar el valor de productUid del producto para el cual desea crear la clave de servicio, puede usar la API de Megaport para crear la clave de servicio.

Para crear una clave de servicio

En Postman, haga clic en Connections (Conexiones) en la navegación izquierda y seleccione Service Keys > POST Generate Service Key (Claves de servicio > POST Generar clave de servicio).

Copie el productUid de su on-ramp (Port) y actualice el Body.

Para este ejemplo, el valor del productUid del Port es 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
    }
}

Especifique parámetros adicionales en el Body, por ejemplo, límite de velocidad (maxSpeed), cuánto tiempo será válida la clave (validFor) y si necesita una clave de un solo uso ("singleUse": true) o de uso múltiple ("singleUse": false). Las fechas se introducen en formato de marca de tiempo UNIX. Puede usar herramientas como https://www.epochconverter.com/ o https://it-tools.tech/date-converter para determinar el valor correcto a introducir.

Para claves de un solo uso, especifique un ID de VLAN (vlan).

Este es el ID de VLAN para el extremo B. Megaport comprueba que el ID de VLAN solicitado esté disponible. Cuando un cliente utiliza esta clave de servicio para crear una conexión a su Port, puede especificar un ID de VLAN para el extremo A.

Para obtener más información sobre los ID de VLAN, consulte Administración de VLAN.
Cuando haya terminado, haga clic en Enviar para realizar la solicitud.
```
POST /v2/service/key
```

Una respuesta exitosa supera la validación y devuelve un estado 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 nueva clave de servicio ahora aparece en el Megaport Portal.

Editar o deshabilitar la clave de servicio

Puede editar los detalles de una clave de servicio o deshabilitarla permanentemente.

Puede haber varias razones por las que quiera deshabilitar la clave. Por ejemplo, crea una clave de servicio para uno de sus Ports y la comparte con su cliente, pero antes de que el cliente cree una conexión con la clave de servicio, el Port deja de estar disponible y usted desea evitar que el cliente use esa clave de servicio.

Para editar o deshabilitar la clave de servicio

En Postman, abra la carpeta Conexiones en la navegación izquierda y seleccione Claves de servicio > PUT Actualizar clave de servicio.
Edite los detalles de la clave de servicio según sea necesario.
Para deshabilitar permanentemente la clave de servicio, establezca el parámetro active en false.

Compartir la clave

Puede compartir la clave de servicio como prefiera, por ejemplo por correo electrónico o mensajería.

Nota

El destinatario de la clave de servicio no puede alterar ni modificar los parámetros de la clave de servicio.

Crear un VXC con una clave de servicio

Después de recibir una clave de servicio, puede crear un VXC con la clave de servicio para conectar el on-ramp del A-End definido en la clave de servicio y su on-ramp del B-End.

Para crear un VXC con una clave de servicio

En Postman, abra la carpeta Conexiones en la navegación izquierda y seleccione Claves de servicio > POST Crear VXC con una clave de servicio.
Especifique los detalles de configuración en el Body de la solicitud.
- productUid - Introduzca el productUid del Port en su ubicación de Megaport.
- bEnd: productUid - Introduzca el productUid de la ubicación del Port obtenido en la búsqueda de la clave de servicio.
- serviceKey - Introduzca la clave de servicio completa.
- ratelimit - Especifique un ratelimit hasta el límite máximo establecido en la clave de servicio.
- term - Especifique la duración del contrato para el VXC. Los valores válidos son 1, 12, 24, 36, 48 y 60 meses. Si no especifica term al solicitar un VXC, el valor predeterminado es 1 (Sin plazo mínimo).
- shutdown - Puede apagar temporalmente y volver a habilitar el VXC. Los valores válidos son true (apagado) y false (habilitado). Si no se proporciona, el valor predeterminado es false (habilitado).
- promoCode - Puede introducir un código promocional para el pedido del servicio. El código no se valida; si el código no existe o no funciona para el servicio, la llamada seguirá siendo correcta.
- vlan - (Opcional) VLAN preferida del extremo A. Especifique un ID de VLAN no utilizado para esta conexión.
  
  Este debe ser un ID de VLAN único en este Port y puede variar de 2 a 4093. Si especifica un ID de VLAN que ya está en uso, el sistema mostrará el siguiente número de VLAN disponible. El ID de VLAN debe ser único para poder continuar con el pedido. Si no especifica un valor, Megaport asignará uno.
  
  La VLAN del extremo B para la terminación del proveedor se completará automáticamente según la clave de servicio.
```
{
    "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"
            }
        }
    ]
}
```
Cuando haya terminado, haga clic en Enviar para realizar la solicitud.
```
POST /v3/networkdesign/buy
```
Consejo

Para probar su solicitud antes de realizar el pedido y ver los detalles de precios, utilice el endpoint /v3/networkdesign/validate con la misma configuración del Body.

Una respuesta exitosa supera la validación y devuelve un estado 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
    }
  ]
}

Después de solicitar el VXC con clave de servicio, se envía una notificación a la empresa con la que se está conectando, y la empresa receptora puede aceptar o rechazar la clave. No pueden modificar la clave, pero pueden solicitar modificaciones a los parámetros de la clave de servicio antes de aceptarla.

El VXC con clave de servicio aparecerá en el portal de Megaport para ambas empresas.