API da Megaport

A Megaport oferece uma API pública que dá acesso a todos os serviços disponíveis pelo Megaport Portal. Você pode usar essa API para automatizar o seu provisionamento da Megaport para economizar tempo e esforço.

A API da Megaport é baseada em REST. Ela tem URLs previsíveis, aceita corpos (bodies) de solicitação codificados como formulário, retorna respostas codificadas em json, e usa códigos de resposta padrão HTTP.

Os tópicos nesta seção descrevem os chamados de API necessários para realizar tarefas comuns como fazer login, criar um Porta, e criar um VXC da Porta até um provedor de nuvem.

Além desses tópicos, você pode ver uma referência completa da API em https://dev.megaport.com.

Ambientes

Há dois ambientes de servidor para as APIs:

Ambiente de produção: https://api.megaport.com
Você é responsável por quaisquer serviços e custos associados solicitados neste sistema.

Mudanças API feitas pelo https://api.megaport.são refletidas no Megaport Portal.
Ambiente de testes (Staging): https://api-staging.megaport.com
Você pode testar qualquer ação neste ambiente de testes, e os chamados de API e respostas correspondem aos do ambiente de produção, mas os serviços não serão lançados e você não será cobrado por qualquer atividade.

A sua conta do portal de teste reflete os serviços de teste criados; no entanto, esses serviços serão resetados a cada 24 horas.

Você pode usar as suas credenciais de produção para fazer login no ambiente de testes e pedir ou editar serviços. (Novas contas de usuários precisam de horas antes de que possam ser usadas no ambiente de testes.)

Mudanças API feitas pelo https://api-staging.megaport.com são refletidas no Staging Portal.

Aviso

As solicitações nos tópicos de API usam a variável {baseUrl}. Você pode substituí-la pela URL do ambiente de testes (https://api-staging.megaport.com) ou com a URL do ambiente de produção (https://api.megaport.com) de acordo com a necessidade de testar configurações ou trabalhar no lançamento de sua produção. Se você usar a coleção do Postman (descrita na seção a seguir), você pode definir variáveis de ambiente na coleção para preencher automaticamente o valor baseUrl em chamados de API e mudar facilmente entre os ambientes de produção e de teste.

Primeiros passos com a API e Postman

Ao escrever e lançar o seu código do lado de cliente para chamar a API da Megaport, você pode usar qualquer linguagem que preferir de Java a Python.

Para passar pelos tutoriais nestes tópicos da API, recomendamos o cliente do Postman com a Coleção da Megaport importada.

O Postman é um cliente HTTP direto e poderoso que ajuda a criar, testar e modificar APIs. Você pode usá-lo para interagir com qualquer funcionalidade de qualquer API. Coleções do Postman são simplesmente um conjunto de solicitações pré-construídas organizadas em pastas, e elas pode ser facilmente exportadas s compartilhadas com outros.

Antes de começar a usar a Coleção da Megaport no Postman, você precisará de uma conta da Megaport Account e precisará também instalar o Postman.

Para configurar a Coleção da Megaport no Postman

Baixe a coleção API do postman de dev.megaport.com.
Clique no botão Executar no Postman no canto superior direito da página linkada.