API API API API API API API API API API API API API API API API API API API API API API API Création d’une clé API

Création d’une clé API

Les appels API de Megaport nécessitent un jeton d’accès que vous pouvez générer après avoir créé une clé API. Un jeton d’accès est requis pour authentifier les utilisateurs de l’API, et permet un accès temporaire uniquement aux parties du Megaport Portal qui sont nécessaires.

Il est recommandé de créer un compte d’entreprise admin de machine à machine (M2M) pour accéder à l’API Megaport et créer des clés API. Dans le cas où un utilisateur humain est désactivé ou verrouillé hors de son compte, les clés API créées par cet utilisateur seront également suspendues, ce qui pourrait arrêter le fonctionnement de toute intégration API.

Les clés API ne sont valides que dans l’environnement dans lequel elles ont été générées. Si vous avez besoin de clés API pour accéder à un environnement différent, connectez-vous au Megaport Portal dans cet environnement et générez les clés API là-bas.

Remarque

Vous devez être connecté au Megaport Portal en tant qu’utilisateur avec le rôle d’Administrateur de l’Entreprise pour Création d’une clé API. Pour plus d’informations, consultez Gestion des rôles utilisateur.
Un maximum de cinq clés API peut être créé par entreprise.

Ce sujet décrit les tâches suivantes:

Création d’une clé API dans le Megaport Portal
Générer un jeton d’accès dans Postman

Pour Création d’une clé API dans le Megaport Portal

Dans le Megaport Portal, choisissez Outils > Générateur de clés API.
L’écran Clés API vous permet de créer des clés API, et de voir et modifier les clés API existantes.
Spécifiez les détails pour la clé API.
- Nom – Entrez un nom pour la clé API.
  Ce devrait être un nom descriptif pour identifier le but de la clé.
  Remarque
  - Un minimum de trois caractères est requis pour le nom de la clé API.
  - Aucun caractère spécial n’est autorisé à l’exception du tiret et du trait d’union.
- Rôle – Sélectionnez le rôle de l’utilisateur qui utilisera l’API.
  Les options suivantes sont disponibles:
  - Administrateur de l’Entreprise
  - Lecture Seule
- Expiration du Jeton (Minutes) – Entrez la durée (en minutes) après laquelle le jeton généré à partir de cette clé expirera. Le minimum est de 5 minutes et le maximum est de 24 heures (1440 minutes). Après l’expiration du jeton, vous devez générer un nouveau jeton d’accès.
Cliquez sur Générer la Clé.
La clé API est créée et le message Votre Clé API apparaît.

Important

Copiez votre nouvelle Clé API et le Secret de votre Clé API, et stockez ces identifiants en lieu sûr. Vous devrez les utiliser pour générer des jetons d’accès. Assurez-vous de copier le Secret de la Clé API car il ne sera plus affiché après la fermeture de ce message.
Cliquez sur Copier à droite du champ Clé API et collez la clé (ID du client) dans un endroit sûr.
Cliquez sur Copier à droite du champ Secret de la Clé API et collez le secret du client dans un endroit sûr.
Cliquez sur Fermer.
La clé API est créée et affichée dans la zone Clés API Actives de l’écran.
Dans la zone Clés API Actives, vous pouvez modifier le nom de la clé, supprimer la clé et voir l’historique des modifications effectuées pour la clé.

Générer un jeton d’accès

Après avoir créé la clé API, composée d’un ID client et d’un secret client, vous pouvez générer un jeton d’accès pour authentifier les utilisateurs de l’API. Ces instructions décrivent comment vous pouvez le faire en utilisant Postman et la collection Megaport. Pour les détails de configuration de Postman, voir Aperçu de l’API Megaport.

L’URL de la requête que vous devez utiliser dépend de l’environnement dans lequel vous générez un jeton d’accès. Dans chaque environnement, ces URL de requêtes doivent être utilisées:

Environnement de production – https://auth-m2m.megaport.com/oauth2/token
Environnement de test (staging) – https://auth-m2m-staging.megaport.com/oauth2/token

Ces instructions décrivent comment générer un jeton d’accès dans l’environnement de production. Pour plus d’informations, voir Aperçu de l’API Megaport et Authentification Megaport - Clés API.

Remarque

Les points de terminaison de l’API qu’un jeton d’accès peut appeler dépendent du rôle sélectionné pour la clé API lors de sa création. Par exemple, les clés API Lecture Seule auront plus de restrictions sur les données pouvant être consultées que les clés API Administrateur de l’Entreprise.

Pour générer un jeton d’accès dans Postman

Dans la collection Megaport importée dans Postman, cliquez sur l’icône plus pour ajouter une nouvelle requête.
Dans la liste déroulante à gauche du champ Request URL, sélectionnez POST.
Dans le champ Request URL, entrez l’URL de requête suivante:
https://auth-m2m.megaport.com/oauth2/token
Sélectionnez l’onglet Authorization et entrez les détails des paramètres suivants:
- Nom d’utilisateur – L’ID client que vous avez copié plus tôt lors de la création de la clé API.
- Mot de passe – Le secret client que vous avez copié plus tôt lors de la création de la clé API.
Remarque

Ces paramètres contiennent des données sensibles. Si vous travaillez dans un environnement collaboratif, vous pourriez souhaiter définir l’ID client et le secret client comme les variables {{apiKeyClientId}} et {{apiKeyClientSecret}} respectivement. Pour plus d’informations sur les variables, consultez la documentation Postman.
Sélectionnez l’onglet Body et entrez une clé appelée grant_type qui est définie sur une valeur de client_credentials.
Cliquez sur Enregistrer.
L’écran Enregistrer la Requête apparaît.
Dans le champ Nom de la requête, entrez un nom significatif pour la nouvelle requête.
Par exemple, Générer le Jeton d’Accès.
(Optionnel) Entrez une description de la requête.
Sélectionnez où vous souhaitez enregistrer la requête puis cliquez sur Enregistrer.
La nouvelle requête est créée et ajoutée à la collection de Documentation API Megaport.
Cliquez sur Envoyer.

Vous devriez recevoir une réponse contenant votre jeton d’accès, semblable à l’exemple ci-dessous. Une fois qu’un jeton d’accès est généré, il peut être utilisé pour authentifier les utilisateurs de l’API pour divers points de terminaison dans le Megaport Portal.
```
 {
  "access_token":  
      "eyJraWQ......2cOQGA",
  "expires_in": 86400,
  "token_type": "Bearer"
 }
```
Copiez le jeton d’accès.
Dans les variables pour la collection (cliquez sur les trois points après la collection Megaport importée > Modifier > Variables), ajoutez une entrée pour access_token et collez le jeton d’accès dans le champ VALEUR ACTUELLE.
Pour chaque appel API que vous devez envoyer, dans l’onglet Authorization, le Type doit être défini sur Token Bearer et le Token doit être défini sur la variable de jeton d’accès {{access_token}}.

L’appel API est maintenant prêt à être utilisé. Tous les appels API sont effectués sur SSL/TLS et chaque appel est validé par rapport au jeton d’accès pour les permissions appropriées.

Remarque

Les jetons d’accès expireront donc vous devrez régulièrement générer de nouveaux jetons pour vos appels API. La période d’expiration est déterminée par la valeur qui a été entrée pour le champ Expiration du Jeton (Minutes) lors de la création de la clé API. La période d’expiration par défaut est de 24 heures.

Les requêtes API incluent deux paramètres d’en-tête importants: Authorization et Content-Type. Le paramètre Authorization pointe vers l’onglet Authorization où la variable de jeton est définie.

En-têtes requis

génération de jeton cURL

Une autre façon de générer un jeton d’accès est d’utiliser cURL à partir d’une console de commande dans le format suivant:

 curl -X "POST" "https://auth-m2m.megaport.com/oauth2/token" \
        -H 'Content-Type: application/x-www-form-urlencoded' \
        -u '<api_key>:<api_key_secret>' \
        --data-urlencode "grant_type=client_credentials"

Conseil

Le site dev.megaport.com vous permet de voir chaque point de terminaison API dans plusieurs langages de programmation.