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 le provisionnement de votre Megaport afin d’économiser du temps et des efforts.

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

Les sujets de cette section présentent les appels API nécessaires pour effectuer des tâches courantes telles que la connexion, la création d’un port et la création d’une VXC depuis le port vers un fournisseur de services cloud.

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

Vous pouvez également commencer par regarder quelques vidéos de présentation :

Lire la vidéo   Regarder une vidéo de 8 minutes d’introduction à l’API Megaport.
Cette vidéo comprend une description par étapes de la connexion au Megaport Portal, l’acquisition de documents tels que les listes de prix et une LOA, et l’utilisation de l’API dans Postman.

Lire la vidéo   Regarder une vidéo de 8 minutes sur la façon d’utiliser l’API pour commander un port et une VXC.

Environnements

Il existe deux environnements de serveur pour les API :

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

    Les modifications apportées à l’API par le biais de https://api.megaport.com sont prises en compte dans le portail.

  • L’environnement de test : https://api-staging.megaport.com
    Vous pouvez tester n’importe quelle action dans cet environnement de test et les appels et réponses de l’API reflètent le système de production, mais les services ne seront pas déployés et aucune activité ne vous sera facturée.

    Votre compte de portail de test reflète les services de test créés ; toutefois, ceux-ci seront réinitialisés toutes les 24 heures.

    Vous pouvez utiliser vos identifiants de production pour vous connecter à l’environnement de test et commander ou modifier des services. (Il faut attendre 24 heures avant de pouvoir utiliser les nouveaux comptes d’utilisateur dans le test).

    Les changements apportés à l’API par le biais de https://api-staging.megaport.com sont pris en compte dans le portail de test.

Remarque

Les requêtes dans les rubriques de l’API utilisent la variable {baseUrl}. Vous pouvez la remplacer par l’URL de test (https://api-staging.megaport.com) ou l’URL de production (https://api.megaport.com) selon que vous souhaitez tester des 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 basculer facilement entre un environnement de test et un environnement de production.

Premiers pas avec l’API et Postman

Lorsque vous écrivez et déployez votre code côté client pour appeler l’API Megaport, vous pouvez utiliser le langage que vous préférez, de Java à Python.

Pour parcourir les tutoriels dans ces rubriques de l’API, nous recommandons le client Postman avec la collection Megaport importée.

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

Avant de pouvoir commencer à utiliser la collection Megaport dans Postman, vous devez disposer d’un compte Megaport et vous devez installer Postman.

Pour configurer la collection Megaport dans Postman :

  • Téléchargez la collection d’API Postman sur le site dev.megaport.com.
    Cliquez sur le bouton Run In Postman (Exécuter dans Postman) dans le coin supérieur droit de la page liée.

Dernière mise à jour: