Avis de Mise Hors Service de l’API et Foire Aux Questions (FAQ)

Ce sujet inclut les avis de mise hors service de l’API et quelques questions courantes sur les changements de version de l’API.

Nous vous recommandons de vous tenir informé de ces changements et de planifier en conséquence toute mise à jour d’intégration API.

Pour plus d’informations sur les APIs mentionnées dans ce sujet, consultez la référence API à https://dev.megaport.com.

Mai 2025 - Changements de version de l’API

Nous avons apporté des mises à jour importantes à notre API qui pourraient vous affecter. À la suite de ces mises à jour, tous les utilisateurs qui intègrent actuellement ces points de terminaison sont tenus de migrer vers les dernières versions.

Les modifications clés sont listées dans le tableau ci-dessous. Les APIs dépréciées seront entièrement mises hors service le 31 juillet 2025.

Passage de la v2 à la v3:

L’API v3 est désormais disponible et requise pour:
- GET location pour tous les services
- POST login avec nom d’utilisateur et mot de passe
- APIs de paramètres de notification
- GET journaux d’activité
- APIs de factures (Notez également que companyId a été mis à jour en companyUid et supplierId a été ajouté à l’URL)

Passage de la v3 à la v4:

GET MVE Image Details

Fonction	Ancienne API	Nouvelle API
GET Locations Renvoie une liste de centres de données où vous pouvez commander un Port, MCR, ou MVE.	GET /v2/locations	GET /v3/locations
POST Log in With Username and Password	POST /v2/login	POST /v3/login
GET List Notification Settings	GET /v2/notificationPreferences	GET /v3/notificationPreferences
PUT Change Notification Settings	PUT /v2/notificationPreferences	PUT /v3/notificationPreferences
GET User Activity	GET /v2/activity	GET /v3/activity Ces points de terminaison sont maintenant tous disponibles : /v3/activity /v3/companyActivity /v3/activityNames /v3/companyActivityNames /v3/companyActivity/users
GET Invoices Renvoie une liste de toutes les factures pour la combinaison entreprise et marché de facturation, pour la plage de dates spécifiée.	/v2/company/${companyid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate}	/v3/company/${companyUid}/invoice/ supplierId/{supplierId}?fromDate=${fromDate} &toDate=${toDate}
GET Single Invoice Renvoie la facture spécifiée au format JSON.	/v2/company/${companyid}/invoice/ ${invoiceId}	/v3/company/{companyUId}/supplier/ {supplierId}/invoice/{invoiceId}
GET Single Invoice PDF	/v2/company/${companyid}/invoice/ ${invoiceId}/pdf	/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/pdf
GET Single Invoice CSV	/v2/company/${companyId}/invoice/ ${invoiceId}/csv	/v3/company/{companyUid}/supplier/ {supplierId}/invoice/{invoiceId}/csv
GET MVE Image Details	GET /v3/product/mve/images	GET /v4/product/mve/images

Février 2024 - Nouvelles APIs de factures

Nos APIs de factures changent.

Pour vous assurer de continuer à recevoir les données de facturation les plus précises, à jour et complètes, y compris les notes de crédit et les informations fiscales, vous êtes tenu de migrer vers les nouveaux points de terminaison de l’API de facturation.

Pour plus d’informations sur les APIs de factures, visitez https://dev.megaport.com.

Quelles APIs de facturation sont affectées?

Ces points de terminaison API ont été dépréciés et remplacés par de nouveaux points de terminaison API.

Fonction	Ancienne API	Nouvelle API
GET Invoices	GET /v2/invoice Renvoie une liste de factures pour l’entreprise associée au compte utilisateur.	GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}? Renvoie une liste de factures pour la combinaison ID d’entreprise et ID de marché de facturation, pour la plage de dates spécifiée.
GET Single Invoice	GET v2/invoice/{invoiceId} Renvoie la facture pour l’`invoiceId` spécifié.	GET /v2/company/${companyId}/invoice/${invoiceId} Renvoie la facture pour le `companyId` et l’`invoiceId` spécifiés au format JSON.
GET Single Invoice PDF	GET /v2/invoice/{invoiceId}/pdf Renvoie une version PDF de la facture pour l’`invoiceId` spécifié.	GET /v2/company/${companyId}/invoice/${invoiceId}/pdf Renvoie une version PDF de la facture pour le `companyId` et l’`invoiceId` spécifiés.
GET Single Invoice CSV	GET /v2/invoice/{invoiceId}/csv Renvoie une version CSV de la facture pour l’`invoiceId` spécifié.	GET /v2/company/${companyId}/invoice/${invoiceId}/csv Renvoie une version CSV de la facture pour le `companyId` et l’`invoiceId` spécifiés.

Où puis-je trouver les informations du fournisseur et de l’entreprise?

Toutes les nouvelles APIs de factures nécessitent l’envoi d’informations d’entreprise et de fournisseur dans l’appel API. Vous pouvez trouver ces valeurs à partir des APIs suivantes de Megaport:

supplierId est le “firstPartyId” retourné dans l’API GET Billing Markets /v2/market pour le fournisseur concerné.
companyUid est retourné dans l’API GET Product List /v2/products ou l’API GET API Keys /v2/auth/apikeys.
companyId est retourné dans l’API GET Company Details /v2/company/companyUid.

Quand dois-je commencer à utiliser les nouvelles APIs de factures?

Dès que possible. Les nouvelles APIs de factures sont actuellement disponibles en Production, toute amélioration future liée aux factures ne sera appliquée qu’aux nouvelles APIs.

Quand les APIs de factures héritées seront-elles mises hors service?

Les APIs de factures héritées ont été dépréciées et ne sont plus prises en charge.

À qui puis-je parler pour plus d’informations?

Veuillez contacter votre Account Manager ou le Support Megaport. Pour plus d’informations, consultez Contacter le support.

Avril 2023 - APIs v2 pour MVE

En avril 2023, nous avons lancé une nouvelle version de Megaport Virtual Edge (MVE). Auparavant, MVE avait été proposé en tant que pack avec des spécifications prédéfinies de calcul, de circuits virtuels et de Megaport Internet. Avec cette dernière version, nous avons dissocié Megaport Internet pour séparer le calcul des Virtual Cross Connects (VXCs) et des connexions Megaport Internet. En dissociant les fonctions de calcul et de transit, vous pouvez désormais obtenir un nouveau niveau de configurabilité et de flexibilité en personnalisant davantage votre réseau pour répondre à vos besoins.

MVE est maintenant également disponible en plusieurs tailles et a le double de la RAM de notre version précédente pour de meilleures performances. Les tailles de calcul sont maintenant 2/8, 4/16, 8/32 et des options de plus grande capacité, où le premier numéro est le CPU et le deuxième numéro est le Go de RAM disponible.

Pour activer cette nouvelle fonctionnalité, une API v3 a été créée pour obtenir les prix, valider, commander, modifier et supprimer MVE et Megaport Internet connexions en tant que produits distincts. Les intégrateurs API existants qui souhaitent changer la vitesse de leur connexion Megaport Internet devront intégrer avec la nouvelle API v3.

En conséquence, les utilisateurs qui intègrent les APIs de Validation et d’Achat pour d’autres types de services, y compris les Ports, MCRs, VXCs, et IXs, en plus des MVEs et des connexions Megaport Internet, seront également tenus de migrer vers la dernière version v3. Aucun changement pour ces types de services, autre que la version, n’est appliqué à l’URL, au corps de la requête ou au corps de la réponse.

Pour maintenir la compatibilité descendante pour nos intégrateurs API existants, les utilisateurs de l’API pourront continuer à utiliser les appels d’API v2 Megaport actuels pour commander des MVE groupés jusqu’au 30 septembre 2024, date à laquelle l’API v2 héritée sera dépréciée. Lors de la commande d’un MVE avec les APIs v2, une connexion Megaport Internet avec la vitesse par défaut associée à la taille MVE sélectionnée sera créée automatiquement.

Tous les intégrateurs sont encouragés à migrer et à commencer à utiliser les APIs v3 lors de la commande de MVEs et de connexions Megaport Internet pour profiter pleinement de la flexibilité supplémentaire.

Notre Customer Portal a déjà basculé sur v3 pour:

Obtenir les prix des MVEs et VXCs:

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

Validation et Achat de tous les types de services:

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

Modifier les VXCs (seulement):

PUT /v3/product/vxc/{productUid}

Supprimer tous les types de services:

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

Quand dois-je commencer à utiliser l’API v3 MVE?

Dès que possible et au plus tard en septembre 2024. Les APIs v3 MVE sont actuellement disponibles en Production, toute amélioration future liée aux connexions MVE et Megaport Internet sera appliquée uniquement aux APIs v3.

Quand les APIs v2 MVE seront-elles dépréciées?

Les APIs v2 MVE seront dépréciées le 30 septembre 2024.

Quelles APIs v2 sont affectées?

Ce tableau liste les APIs v2 affectées par ces changements:

Fonction	Ancienne API	Nouvelle API
Get MVE Price	GET /v2/pricebook/mve Renvoie le prix de MVE + connexion Megaport Internet.	GET /v3/pricebook/mve Renvoie le prix du calcul MVE uniquement.
Get VXC Price	GET /v2/pricebook/vxc Ne renvoie pas le prix Megaport Internet.	GET /v3/pricebook/vxc Avec connectType=transit, renvoie le prix de la connexion Megaport Internet.
Validate orders for all product types: Port, MCR, MVE, VXC, IX	POST /v2/networkdesign/validate Pour les MVE, valide la commande de MVE + connexion Megaport Internet ensemble.	POST /v3/networkdesign/validate Pour les MVE, valide la commande de MVE uniquement. Remarque : Les tailles disponibles sont : `"SMALL" "MEDIUM" "LARGE" "X_LARGE_12"`.
Buy services for all product types: Port, MCR, MVE, VXC, IX	POST /v2/networkdesign/buy Pour les MVE, achète MVE + connexion Megaport Internet ensemble.	POST /v3/networkdesign/buy Pour les MVE, achète le MVE uniquement. Peut acheter des connexions Megaport Internet seules.
Update VXC Details	PUT /v2/product/vxc/{productUid} Ne peut pas mettre à jour les connexions Megaport Internet.	PUT /v3/product/vxc/{productUid} Peut mettre à jour les connexions Megaport Internet.
Delete services for all product types: Port, MCR, MVE, VXC, IX	POST /v2/product/{productUid}/ action/{action}	POST /v3/product/{productUid}/ action/{action}

Que se passe-t-il si je n’ai pas migré à temps?

Votre intégration MVE cessera de fonctionner et vous ne pourrez pas commander de nouveaux ou mettre à jour des MVE existants. Pour plus d’informations, veuillez contacter votre Account Manager.

À qui puis-je parler pour plus d’informations?

Veuillez contacter votre Account Manager ou le Support Megaport. Pour plus d’informations, consultez Contacter le support.