Pular para conteúdo

Criando uma Port com a API

Este tópico descreve o procedimento da API para criar um Port, incluindo como procurar localizações de Port, validar o Port e determinar o custo, solicitar o Port e baixar a Carta de Autorização (LOA)Uma Carta de Autorização (LOA) é um documento que os clientes precisam apresentar ao seu provedor de data center para estabelecer o cross-connect físico dos seus serviços de data center até o seu Port. A LOA é fornecida por meio do Megaport Portal quando um cliente provisiona um novo Port.
.

Antes de começar, obtenha um token de acesso válido. Para mais informações, consulte Criando uma chave de API.

Para procurar detalhes de localização de Port na coleção do Postman

  1. Clique em Locations (Locais) na navegação à esquerda e clique em GET Locations (v3) (GET Localizações (v3)).
    Esta solicitação não espera informações de Parameters ou Body.

  2. Clique em Send (Enviar) para fazer a solicitação.

    GET {baseUrl}/v3/locations
    

    Obter localizações

    Verifique se a solicitação foi bem-sucedida procurando por Status: 200 OK e exiba a resposta na seção Body no formato Pretty.

    A solicitação retorna centenas de localizações de Port. Você pode pesquisar clicando no ícone de lupa e inserindo uma cidade específica, data center ou outro parâmetro no campo de pesquisa. Este exemplo usa a localização Digital Realty, London.

{
            "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
                }
            }
        }

Para criar um Port, você precisa dos valores market e id. Neste exemplo, o mercado é UK e o ID do data center é 89.

Para testar e validar o pedido de Port

  1. No Postman, abra a pasta Ports (Ports) na navegação à esquerda e selecione POST Validate Port Order (v3) (POST Validar Pedido de Port (v3)).

  2. Atualize o Body com o locationId (89), term (número de meses - 1, 12, 24, 36, 48 ou 60), productName (qualquer nome que você queira para seu Port), portSpeed (1000, 10000 ou 100000 Mbps) e market (UK) e clique em Send (Enviar).

[
  {
    "locationId": 89,
    "term": 1,
    "locationUid": null,
    "productName": "API Port",
    "productType": "MEGAPORT",
    "createDate": 1452475039656,
    "portSpeed": 1000,
    "virtual": false,
    "promoCode": "promox3mnthfree2",
    "market": "UK"
  }
]

Uma resposta bem-sucedida passa na validação e tem status 200 OK. A resposta também inclui detalhes de preços do serviço.

{
    "message": "Validation passed",
    "terms": "This data is 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"
        }
    ]
}

Para solicitar o Port validado

  1. Com uma solicitação de Port validada e informações de custo revisadas, copie o Body de POST Validate Port Order (v3) (POST Validar pedido de Port (v3)) e cole no Body de POST Buy Port (v3) (POST Comprar Port (v3)).

    Importante

    Se você fizer essa chamada em api.megaport.com, sua conta será cobrada pelo serviço. Como alternativa, você pode provisionar na API de staging sem cobranças, como nestes exemplos.

  2. Envie a solicitação.
    Uma resposta bem-sucedida inclui um technicalServiceUid, que é o mesmo que o productUid.
    No nosso exemplo, esse valor é a49cf3f1-20a1-4390-93aa-5005bdafe3d7.

{
    "message": "MEGAPORT [a49cf3f1-20a1-4390-93aa-5005bdafe3d7] created. ",
    "terms": "This data is 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
        }
    ]
}

O novo Port agora aparece no seu ambiente de trabalho, seja em portal.megaport.com ou em portal-staging.megaport.com.

Novo Port de API

Dica

Para ver todas as opções das solicitações usadas neste exemplo, consulte https://dev.megaport.com.

Baixar a Carta de Autorização (LOA)

Depois de criar seu Port, você pode baixar a LOA.

Nota

Antes de poder baixar a LOA, o Status de Provisionamento do Port deve estar Configurado.

Para baixar a LOA

  1. No Postman, expanda Ports (Ports) na navegação à esquerda e selecione GET Regenerate LOA for Megaport Service (GET Regenerar LOA para o serviço Megaport).

  2. No comando GET, substitua o productID pelo valor criado durante a criação do Port.

  3. Envie a solicitação.

    Com uma resposta 200 OK bem-sucedida, esta mensagem aparece na seção Body:

    Esta resposta não pôde ser visualizada. 
    Baixe a resposta para abri-la com um aplicativo apropriado.
    

    Esta mensagem aparece porque a LOA é um documento PDF e deve ser baixada. Para baixar, clique em Save Response (Salvar resposta) no Postman e salve o PDF em um local conveniente.