Megaport Visão geral da API

Megaport oferece uma API pública para acesso a todos os serviços disponíveis por meio do Megaport Portal. Você pode usar essa API para automatizar o provisionamento da Megaport e economizar tempo e esforço.

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

Os tópicos desta seção conduzem você pelas chamadas de API necessárias para executar tarefas comuns, como fazer login, criar um Port e criar um VXC do Port para um provedor de nuvem.

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

Nota

De tempos em tempos, atualizamos, mudamos versões e descontinuamos APIs ao lançar novas funcionalidades. Recomendamos manter-se atualizado com essas mudanças e planejar as atualizações de integração de API conforme necessário. Para obter mais informações, consulte Avisos de descontinuação de API e Perguntas frequentes (FAQs).

Ambientes

Existem 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.

As alterações de API por meio de https://api.megaport.com são refletidas no Megaport Portal.
Ambiente de staging (teste) – https://api-staging.megaport.com
Você pode testar qualquer ação neste ambiente de staging, e as chamadas e respostas da API espelham o sistema de produção, mas os serviços não serão implantados e você não será cobrado por nenhuma atividade.

Sua conta do portal de staging reflete os serviços de staging criados; no entanto, eles serão redefinidos a cada 24 horas.

Você pode usar suas credenciais de produção para fazer login no ambiente de staging e solicitar ou editar serviços. (Novas contas de usuário levam 24 horas antes de ficarem disponíveis para uso no staging.)

As alterações de API por meio de https://api-staging.megaport.com são refletidas no Staging Portal.

Nota

As solicitações nos tópicos da API usam a variável {baseUrl}. Você pode substituí-la pela URL de staging (https://api-staging.megaport.com) ou pela URL de produção (https://api.megaport.com), dependendo se deseja testar configurações ou trabalhar com sua implantação de produção. Se você usar a coleção do Postman (descrita na próxima seção), poderá definir environment variables na coleção para preencher automaticamente o valor de baseUrl nas solicitações de API e alternar facilmente entre os ambientes de staging e de produção.

Introdução à API e ao Postman

Ao escrever e implantar seu código do lado do cliente para chamar a API da Megaport, você pode usar qualquer linguagem de sua preferência, de Java a Python.

Para seguir os tutoriais nestes tópicos de API, recomendamos o cliente Postman com a Coleção da Megaport importada.

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

Antes de começar com a Coleção da Megaport no Postman, você precisa de uma Megaport Account e precisa install Postman.

Para configurar a Coleção da Megaport no Postman

Baixe a coleção da API do Postman em dev.megaport.com.
Clique no botão Run In Postman (Executar no Postman) no canto superior direito da página vinculada.