Aperçu de l’API Megaport

Megaport propose une API publique pour accéder à tous les services disponibles via le Megaport Portal. Vous pouvez utiliser cette API pour automatiser votre approvisionnement Megaport afin de gagner du temps et des efforts.

L’API Megaport est basée sur REST. L’API a des URL prévisibles, accepte les corps de requêtes encodés en formulaire, renvoie des réponses encodées en JSON et utilise des codes de réponse HTTP standard.

Les sujets de cette section vous guident à travers les appels d’API nécessaires pour effectuer des tâches courantes telles que la connexion, la création d’un Port, et la création d’un VXC depuis le Port vers un fournisseur cloud.

Au-delà de ces sujets, vous pouvez consulter une référence complète de l’API sur https://dev.megaport.com.

Remarque

De temps en temps, nous mettons à jour, changeons de versions, et déprécions des API lors de la sortie de nouvelles fonctionnalités. Nous vous recommandons de rester à jour avec ces changements et de planifier en conséquence les mises à jour d’intégration API. Pour plus d’informations, consultez les Notifications de dépréciation d’API et Foire Aux Questions (FAQ).

Environnements

Il existe deux environnements serveur pour les API:

Environnement de production – https://api.megaport.com
Vous êtes responsable de tous les services et des coûts associés commandés dans ce système.

Les modifications de l’API via https://api.megaport.com sont reflétées dans le Megaport Portal.
Environnement de préproduction (test) – https://api-staging.megaport.com
Vous pouvez tester toute action dans cet environnement de préproduction et les appels API ainsi que les réponses reflètent le système de production, mais les services ne seront pas déployés et vous ne serez pas facturé pour toute activité.

Votre compte portail de préproduction reflète les services créés en préproduction ; cependant, ils seront réinitialisés toutes les 24 heures.

Vous pouvez utiliser vos identifiants de production pour vous connecter à l’environnement de préproduction et commander ou modifier des services. (Les nouveaux comptes utilisateurs prennent 24 heures avant d’être disponibles en préproduction.)

Les modifications de l’API via https://api-staging.megaport.com sont reflétées dans le Staging Portal.

Remarque

Les requêtes dans les sujets API utilisent la variable {baseUrl}. Vous pouvez la remplacer par l’URL de préproduction (https://api-staging.megaport.com) ou l’URL de production (https://api.megaport.com) selon que vous souhaitez tester les configurations ou travailler avec votre déploiement de production. Si vous utilisez la collection Postman (décrite dans la section suivante), vous pouvez définir des variables d’environnement dans la collection pour remplir automatiquement la valeur baseUrl dans les requêtes API et passer facilement entre les environnements de préproduction et de production.

Pour commencer avec l’API et Postman

Lors de l’écriture et du déploiement de votre code côté client pour appeler l’API Megaport, vous pouvez utiliser n’importe quel langage que vous préférez, de Java à Python.

Pour suivre les tutoriels dans ces sujets API, nous recommandons le client Postman avec la collection Megaport importée.

Postman est un client HTTP simple et puissant qui aide à construire, tester et modifier les APIs. Vous pouvez l’utiliser pour interagir avec n’importe quelle fonctionnalité sur n’importe quelle API. Les collections Postman sont simplement un ensemble de requêtes préconstruites organisées en dossiers, et elles peuvent être facilement exportées et partagées avec d’autres.

Avant de pouvoir commencer avec la collection Megaport dans Postman, vous avez besoin d’un Compte Megaport et vous devez installer Postman.

Pour configurer la collection Megaport dans Postman

Téléchargez la collection API Postman à partir de dev.megaport.com.
Cliquez sur le bouton Run In Postman en haut à droite de la page liée.