API API API API API API API API API API API API API API API API API API API API API API API Creazione di una Chiave di Servizio

Creazione di una Chiave di Servizio con l’API

Questo argomento descrive la procedura API per creare una chiave di servizio, inclusi come ottenere l’ID del Port (productUid) e creare un VXC con una chiave di servizio.

Per una panoramica delle chiavi di servizio, vedere Configurazione delle chiavi di servizio e Gestione chiavi di servizio. Per ulteriori informazioni sulle API delle chiavi di servizio, vedi Chiavi di Servizio (Documentazione API).

Prerequisiti

Accesso al Megaport Portal.
Una Port, MCR, o MVE sulla rete Megaport.
Hai un token di accesso valido. Per ulteriori informazioni, vedere Creazione di una chiave API.

Per ottenere il productUid per il Port

In Postman, fai clic su Dettagli Prodotto nella navigazione a sinistra e seleziona GET Lista Prodotti.
Fare clic su Invia.
Dai dettagli del prodotto restituiti, individua il valore productUid per il Port per il quale vuoi creare la chiave di servizio.

Questo esempio utilizza il seguente Port:
```
"productName": "CoreSite LA1" in "city": "Los Angeles" 
with "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
```

Creazione di una chiave di servizio

Dopo aver individuato il valore productUid per il prodotto per il quale vuoi creare la chiave di servizio, puoi usare l’API Megaport per creare la chiave di servizio.

Per creare una chiave di servizio

In Postman, fai clic su Connessioni nella navigazione a sinistra e seleziona Chiavi di Servizio > POST Genera Chiave di Servizio.

Copia il productUid del tuo on-ramp (Port) e aggiorna il Body.

Per questo esempio, il valore del productUid del Port è 8611b645-ea50-46eb-b400-1c2fb858a303.

{
    "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303",
    "description": "Chiave di Servizio Documentazione - Singolo Uso",
    "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
    }
}

Specifica parametri aggiuntivi nel corpo della richiesta, ad esempio il limite di velocità (maxSpeed), la durata di validità della chiave (validFor) e se hai bisogno di una chiave monouso ("singleUse": true) o multiuso ("singleUse": false). Le date devono essere inserite nel formato data UNIX timestamp. Puoi utilizzare strumenti come
https://www.epochconverter.com/ o https://it-tools.tech/date-converter per determinare il valore corretto da inserire.

Solo per le chiavi monouso, specifica un ID VLAN (vlan).

Questo è l’ID VLAN per il B-End. Megaport verifica che l’ID VLAN richiesto sia disponibile. Quando un cliente utilizza questa chiave di servizio per creare una connessione alla tua Porta, può specificare un ID VLAN per l’A-End.

Per ulteriori informazioni sugli ID VLAN, consulta Gestione degli ID VLAN.
Quando hai terminato, fai clic su Invia per inviare la richiesta.
```
POST /v2/service/key
```

Una risposta positiva supera la convalida e restituisce uno stato 200 OK.

{
    "message": "Nuova chiave di servizio [106e38ae-eb59-415f-ac81-526a5299851d] generata",
    "terms": "Questi dati sono soggetti alla Policy di Uso Accettabile 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": "Chiave di Servizio Documentazione - Singolo Uso",
        "productId": 193076,
        "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303",
        "productName": "Il mio nuovo 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": "Il mio nuovo 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": "Riferimento finanziario opzionale",
            "usageAlgorithm": "NON_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 nuova chiave di servizio appare ora nel Megaport Portal.

Modifica o disabilitazione della chiave

Puoi modificare i dettagli di una chiave di servizio o disabilitarla definitivamente.

Ci possono essere diversi motivi per cui vuoi disabilitare la chiave. Ad esempio, crei una chiave di servizio per una delle tue Porte e la condividi con il cliente, ma prima che il cliente crei una connessione con la chiave di servizio, la Porta diventa non disponibile e vuoi impedire al cliente di usare quella chiave.

Per modificare o disabilitare la chiave di servizio

In Postman, apri la cartella Connessioni nella navigazione a sinistra e seleziona Chiavi di Servizio > PUT Aggiorna chiave di servizio.
Modifica i dettagli della chiave di servizio come necessario.
Per disabilitare definitivamente la chiave di servizio, imposta il parametro active su false.

Condivisione della chiave

Puoi condividere la chiave del servizio nel modo che preferisci, ad esempio tramite email o messaggi.

Nota

Il destinatario della chiave del servizio non può alterare o modificare i parametri della chiave del servizio.

Creare un VXC con una chiave di servizio

Dopo aver ricevuto una chiave di servizio, puoi creare un VXC con la chiave per connettere l’on-ramp A-End definito nella chiave di servizio e il tuo on-ramp B-End.

Per creare un VXC con una chiave di servizio

In Postman, apri la cartella Connessioni nella navigazione a sinistra e seleziona Chiavi di servizio > POST Crea VXC con una chiave di servizio.
Specifica i dettagli di configurazione nel corpo della richiesta.
- productUid - Inserisci il productUid della Porta nella tua posizione Megaport.
- bEnd: productUid - Inserisci il productUid della posizione ottenuta dalla chiave di servizio.
- serviceKey - Inserisci la chiave di servizio completa.
- ratelimit - Specifica un ratelimit fino al limite massimo impostato sulla chiave di servizio.
- term - Specifica la durata del contratto per il VXC. I valori validi sono 1, 12, 24 e 36 mesi. Se non specifichi term quando ordini un VXC, il valore predefinito è 1 (Nessun termine minimo).
- shutdown - Puoi temporaneamente arrestare e riattivare il VXC. I valori validi sono true (arrestato) e false (abilitato). Se non fornito, il valore predefinito è false (abilitato).
- promoCode - Puoi inserire un codice promozionale per l’ordine del servizio. Il codice non viene validato, quindi se il codice non esiste o non funziona per il servizio, la chiamata avrà comunque successo.
- vlan - (Opzionale) VLAN A-End Preferita. Specifica un ID VLAN non usato per questa connessione.
  
  Deve essere un ID VLAN unico su questa Porta e può variare da 2 a 4093. Se specifichi un ID VLAN già in uso, il sistema mostra il prossimo numero VLAN disponibile. L’ID VLAN deve essere unico per procedere con l’ordine. Se non specifichi un valore, Megaport ne assegnerà uno.
  
  La VLAN B-End per la cessazione lato provider sarà popolata automaticamente in base alla chiave di servizio.
```
{
    "productUid": "7fba50bb-ac35-465b-9b8b-9a6d7335ec7a",
    "associatedVxcs": [
        {
            "productName": "VXC da chiave di servizio",
            "rateLimit": 100,
            "term": 12,
            "shutdown": false,
            "promoCode": "promox3mnthfree2",
            "serviceKey": "106e38ae-eb59-415f-ac81-526a5299851d",
            "aEnd": {
                "vlan": 2
            },
            "bEnd": {
                "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
            }
        }
    ]
}
```
Quando hai finito, clicca su Invia per effettuare la richiesta.
```
POST /v3/networkdesign/buy
```
Suggerimento

Per testare la tua richiesta prima di ordinare e vedere i dettagli dei prezzi, usa l’endpoint /v3/networkdesign/validate con la stessa configurazione del corpo.

Una risposta di successo supera la validazione e ha uno stato 200 OK.

{
  "message": "VXC [399f0fd8-8a69-4e15-abdb-537b0cb8a858] creato. ",
  "terms": "Questi dati sono soggetti alla Policy di Uso Accettabile https://www.megaport.com/legal/acceptable-use-policy",
  "data": [
    {
      "createDate": 1610140443499,
      "vxcOrderId": 55791,
      "payerMegaPortId": 74841,
      "nonPayerMegaPortId": 39950,
      "payerMegaPortName": "Il mio Port API LA",
      "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": "Nome Test",
      "payerApproverId": 32278,
      "nonPayerApproverName": null,
      "nonPayerApproverId": null,
      "payerApproval": 1610140443263,
      "nonPayerApproval": 1610140443308,
      "fixedTerm": true,
      "duration": 1,
      "rollover": true,
      "serviceName": "da Il mio Port API LA a 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
    }
  ]
}

Dopo aver ordinato il VXC della chiave di servizio, viene inviata una notifica all’azienda a cui ti stai connettendo, e l’azienda ricevente può accettare o rifiutare la chiave. Non possono modificare la chiave ma possono richiedere modifiche ai parametri della chiave di servizio prima di accettarla.

Il VXC della chiave di servizio apparirà nel Megaport Portal per entrambe le aziende.