Avisos de descontinuação de API e Perguntas frequentes (FAQs)

Este tópico inclui avisos de descontinuação de API e algumas perguntas comuns sobre as mudanças de versão da API.

Recomendamos que você se mantenha atualizado com essas mudanças e planeje as atualizações de integração de API conforme necessário.

Para mais informações sobre as APIs mencionadas neste tópico, consulte a referência da API em https://dev.megaport.com.

Setembro de 2025 - Novas APIs de preços v4

Fizemos algumas atualizações importantes em nossas APIs de preços, que podem afetar você. Uma nova versão, v4, agora está disponível e substitui as APIs de preços v2 e v3 anteriores. Esta versão é necessária para obter preços de todos os serviços, incluindo Ports, MCRs, MVEs, VXCs, conexões Megaport Internet, IXs e produtos adicionais como Cross Connects.

Para garantir que seu sistema continue funcionando sem interrupções, todos os usuários que integram com essas APIs devem migrar para as versões mais recentes. Comece a migrar suas chamadas de API para v4, pois todas as futuras solicitações de preços para serviços novos e existentes e cobranças adicionais serão suportadas apenas nesta versão. O Megaport Terraform Provider não é afetado por essas atualizações.

As principais mudanças estão listadas na tabela abaixo. As APIs v2 e v3 descontinuadas serão totalmente desativadas em 15 de março de 2026.

Para mais informações sobre as APIs de preços, consulte https://dev.megaport.com.

Função	API antiga	Nova API
GET Preço de Port	GET /v2/pricebook/megaport	POST /v4/pricebook/product
GET Preço de VXC (v3)	GET /v3/pricebook/vxc	POST /v4/pricebook/product
GET Preço de Megaport Internet (v3)	GET /v3/pricebook/vxc	POST /v4/pricebook/product
GET Preço de MCR	GET /v2/pricebook/mcr2	POST /v4/pricebook/product
GET Preço de MVE - Sem Megaport Internet (v3)	GET /v3/pricebook/mve	POST /v4/pricebook/product
GET Preço de IX	GET /v2/pricebook/ix	POST /v4/pricebook/product
GET Preço de endereço IP (Novo)	N/A	POST /v4/pricebook/product
GET Preço de Cross Connect (Novo)	N/A	POST /v4/pricebook/addon
GET Preço de IPsec (Novo/Em breve)	N/A	POST /v4/pricebook/addon
GET Detalhes do prazo contratual	GET /v2/product/portTerms/{productUid}	POST /v4/pricebook/product/terms

Maio de 2025 - Mudanças de versão da API

Fizemos algumas atualizações importantes na nossa API que podem afetar você. Como resultado das atualizações, todos os usuários que atualmente integram com esses endpoints devem migrar para as versões mais recentes.

As principais mudanças estão listadas na tabela abaixo. As APIs descontinuadas serão totalmente desativadas em 31 de julho de 2025.

Migrando de v2 para v3:

A API v3 agora está disponível e é obrigatória para:
- GET localização para todos os serviços
- POST login com nome de usuário e senha
- APIs de configurações de notificação
- GET logs de atividade
- APIs de fatura (Observe também que companyId foi atualizado para companyUid e supplierId foi adicionado à URL)

Migrando de v3 para v4:

GET Detalhes de imagem de MVE

Função	API antiga	Nova API
GET Localizações Retorna uma lista de data centers onde você pode solicitar um Port, MCR, ou MVE.	GET /v2/locations	GET /v3/locations
POST Fazer login com nome de usuário e senha	POST /v2/login	POST /v3/login
GET Lista de configurações de notificação	GET /v2/notificationPreferences	GET /v3/notificationPreferences
PUT Alterar configurações de notificação	PUT /v2/notificationPreferences	PUT /v3/notificationPreferences
GET Atividade do usuário	GET /v2/activity	GET /v3/activity Todos estes endpoints agora estão disponíveis: /v3/activity /v3/companyActivity /v3/activityNames /v3/companyActivityNames /v3/companyActivity/users
GET Faturas Retorna uma lista de todas as faturas para a combinação de empresa e mercado de cobrança, para o intervalo de datas especificado.	/v2/company/${companyid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate}	/v3/company/${companyUid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate}
GET Fatura única Retorna a fatura especificada em formato JSON.	/v2/company/${companyid}/invoice/ ${invoiceId}	/v3/company/{companyUId}/supplier/ {supplierId}/invoice/{invoiceId}
GET PDF de fatura única	/v2/company/${companyid}/invoice/ ${invoiceId}/pdf	/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/pdf
GET CSV de fatura única	/v2/company/${companyId}/invoice/ ${invoiceId}/csv	/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/csv
GET Detalhes de imagem de MVE	GET /v3/product/mve/images	GET /v4/product/mve/images

Fevereiro de 2024 - Novas APIs de fatura

Nossas APIs de fatura estão mudando.

Para garantir que você continue recebendo os dados de fatura mais precisos, atualizados e completos, incluindo notas de crédito e informações fiscais, é necessário migrar para os novos endpoints de API de fatura.

Para mais informações sobre as APIs de fatura, consulte https://dev.megaport.com.

Quais APIs de fatura são afetadas?

Esses endpoints de API foram descontinuados e substituídos por novos endpoints de API.

Função	API antiga	Nova API
GET Faturas	GET /v2/invoice Retorna uma lista de faturas da empresa associada à conta do usuário.	GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}? Retorna uma lista de faturas para a combinação de ID da empresa e ID do mercado de cobrança, para o intervalo de datas especificado.
GET Fatura única	GET v2/invoice/{invoiceId} Retorna a fatura para o `invoiceId` especificado.	GET /v2/company/${companyId}/invoice/${invoiceId} Retorna a fatura para os `companyId` e `invoiceId` especificados em formato JSON.
GET PDF de fatura única	GET /v2/invoice/{invoiceId}/pdf Retorna uma versão em PDF da fatura para o `invoiceId` especificado.	GET /v2/company/${companyId}/invoice/${invoiceId}/pdf Retorna uma versão em PDF da fatura para os `companyId` e `invoiceId` especificados.
GET CSV de fatura única	GET /v2/invoice/{invoiceId}/csv Retorna uma versão em CSV da fatura para o `invoiceId` especificado.	GET /v2/company/${companyId}/invoice/${invoiceId}/csv Retorna uma versão em CSV da fatura para os `companyId` e `invoiceId` especificados.

Onde encontro as informações do fornecedor e da empresa?

Todas as novas APIs de fatura exigem que você envie informações da empresa e do fornecedor como parte da chamada de API. Você pode encontrar esses valores nas seguintes APIs da Megaport:

supplierId é o “firstPartyId” retornado na API GET Billing Markets /v2/market do fornecedor relevante.
companyUid é retornado na API GET Product List /v2/products ou na API GET API Keys /v2/auth/apikeys.
companyId é retornado na API GET Company Details /v2/company/companyUid.

Quando preciso começar a usar as novas APIs de fatura?

O mais rápido possível. As novas APIs de fatura já estão disponíveis em Produção; quaisquer melhorias futuras relacionadas a faturas serão aplicadas somente às novas APIs.

Quando as APIs de fatura legadas serão desativadas?

As APIs de fatura legadas foram descontinuadas e não são mais suportadas.

Com quem posso falar para obter mais informações?

Entre em contato com seu Gerente de Conta ou o Suporte da Megaport. Para mais informações, consulte Como entrar em contato com o Suporte.

Abril de 2023 - APIs v2 de MVE

Em abril de 2023, lançamos uma nova versão do Megaport Virtual Edge (MVE). Anteriormente, o MVE era oferecido como um pacote com computação, circuitos virtuais e especificações de Megaport Internet predefinidas. Com esta versão mais recente, separamos o Megaport Internet para desvincular a computação dos Virtual Cross Connects (VXCs) e das conexões Megaport Internet. Ao desagregar as funções de computação e trânsito, você obtém um novo nível de configurabilidade e flexibilidade ao personalizar ainda mais sua rede para atender às suas necessidades.

O MVE agora também está disponível em vários tamanhos e possui o dobro de RAM em relação à versão anterior para melhor desempenho. Os tamanhos de computação agora são 2/8, 4/16, 8/32 e opções de maior capacidade, em que o primeiro número é a CPU e o segundo é a quantidade de RAM (GB) disponível.

Para habilitar esse novo recurso, foi criada uma API v3 para obter preços, validar, pedir, editar e excluir MVE e conexões Megaport Internet como produtos separados. Integradores de API existentes que desejarem alterar a velocidade de sua conexão Megaport Internet precisarão integrar com a nova API v3.

Como resultado, usuários que integram com as APIs Validate e Buy para outros tipos de serviço, incluindo Ports, MCRs, VXCs e IXs, além de MVEs e conexões Megaport Internet, também precisarão migrar para a versão v3 mais recente. Nenhuma mudança para esses tipos de serviço, além da versão, é aplicada à URL, ao corpo da requisição ou ao corpo da resposta.

Para manter a compatibilidade retroativa para nossos integradores de API existentes, os usuários de API poderão continuar usando as chamadas de API v2 atuais do Megaport para pedir MVEs em pacote até 30 de setembro de 2024, quando a API v2 legada será descontinuada. Ao solicitar um MVE com APIs v2, uma conexão Megaport Internet com a velocidade padrão associada ao tamanho do MVE selecionado será criada automaticamente.

Recomendamos que todos os integradores migrem e comecem a usar as APIs v3 ao solicitar MVEs e conexões Megaport Internet para aproveitar ao máximo a flexibilidade adicional.

Nosso Portal do Cliente já migrou para v3 para:

Obter preços de MVEs e VXCs:

GET /v3/pricebook/mve?locationId={locationId}&vendor={vendor}&size={size}
GET /v3/pricebook/vxc?bLocationId={bLocationId}&aLocationId={aLocationId}

Validate e Buy de todos os tipos de serviço:

POST /v3/networkdesign/validate
POST /v3/networkdesign/buy

Atualizar VXCs (somente):

PUT /v3/product/vxc/{productUid}

Excluir todos os tipos de serviço:

POST /v3/product/{productUid}/action/{action}

Quando preciso começar a usar a API v3 de MVE?

O mais rápido possível e, no máximo, até setembro de 2024. As APIs v3 de MVE já estão disponíveis em Produção; quaisquer melhorias futuras relacionadas a MVE e conexões Megaport Internet serão aplicadas somente às APIs v3.

Quando as APIs v2 de MVE serão descontinuadas?

As APIs v2 de MVE serão descontinuadas em 30 de setembro de 2024.

Quais APIs v2 são afetadas?

Esta tabela lista as APIs v2 afetadas por essas mudanças:

Função	API antiga	Nova API
Obter preço de MVE	GET /v2/pricebook/mve Retorna o preço de MVE + conexão Megaport Internet.	GET /v3/pricebook/mve Retorna o preço apenas da computação de MVE.
Obter preço de VXC	GET /v2/pricebook/vxc Não retorna o preço de Megaport Internet.	GET /v3/pricebook/vxc Com connectType=transit, retorna o preço da conexão Megaport Internet.
Validar pedidos para todos os tipos de produto: Port, MCR, MVE, VXC, IX	POST /v2/networkdesign/validate Para MVEs, valida o pedido de MVE + conexão Megaport Internet juntos.	POST /v3/networkdesign/validate Para MVEs, valida o pedido apenas do MVE. Nota: Os tamanhos disponíveis são: `"SMALL" "MEDIUM" "LARGE" "X_LARGE_12"`.
Comprar serviços para todos os tipos de produto: Port, MCR, MVE, VXC, IX	POST /v2/networkdesign/buy Para MVEs, compra MVE + conexão Megaport Internet juntos.	POST /v3/networkdesign/buy Para MVEs, compra apenas o MVE. Pode comprar conexões Megaport Internet separadamente.
Atualizar detalhes de VXC	PUT /v2/product/vxc/{productUid} Não é possível atualizar conexões Megaport Internet.	PUT /v3/product/vxc/{productUid} É possível atualizar conexões Megaport Internet.
Excluir serviços para todos os tipos de produto: Port, MCR, MVE, VXC, IX	POST /v2/product/{productUid}/ action/{action}	POST /v3/product/{productUid}/ action/{action}

O que acontece se eu não tiver migrado a tempo?

Sua integração de MVE deixará de funcionar e você não poderá solicitar novos MVEs nem atualizar os existentes. Para mais informações, entre em contato com seu Gerente de Conta.

Com quem posso falar para obter mais informações?

Entre em contato com seu Gerente de Conta ou o Suporte da Megaport. Para mais informações, consulte Como entrar em contato com o Suporte.