L'API Equinix
Equinix™ offre une API HTTP RESTful accessible à l'adresse https://api.equinix.com/. Ce document décrit l'API et son utilisation.
L'API vous permet d'interagir par programmation avec vos ressources Equinix, notamment les projets, les appareils, les connexions, les commandes, les déploiements de colocation, les tickets d'assistance et la gestion des identités et des accès.
Utilisation de l'API Equinix
L'utilisation de l'API peut être décomposée en flux d'autorisation et en flux de requête.
L'interaction avec les produits Equinix via l'API nécessite:
- Compte du portail client Equinix ou fournisseur OIDC.
- Autorisations de création, de modification et de suppression propres au produit.
Flux d'autorisation de l'utilisateur
-
Enregistrez et autorisez une application dans le portail client.
-
Demandez l'accès et actualisez les informations du jeton en appelant
/oauth2/v1/tokenavec la clé du consommateur, le secret du consommateur et vos informations d'identification utilisateur.
-
Votre requête vous retourne le jeton d'accès OAuth à durée de vie limitée et son jeton d'actualisation associé.
Pour plus d'informations et des instructions plus détaillées, consultez Authentification API.
Flux d'autorisation des jetons OIDC
-
Create an OIDC Provider in either the Customer Portal or the Equinix API.
-
Demandez l'accès en appelant le point de terminaison
/v1/tokenavec votre jeton de fournisseur d'identité et votre étendue.
- Votre requête retourne le jeton d'accès temporaire.
Pour plus d'informations, consultez Authentification de l'API OIDC.
Le flux de requêtes
-
À l’aide d’un jeton d’accès OAuth valide pour autoriser une demande, appelez un point de terminaison d’API avec l’en-tête d’autorisation requis.
-
La passerelle API valide la demande et appelle l'API Equinix concernée.
-
La réponse est reçue par la passerelle API.
-
La réponse vous est renvoyée.
Infrastructure en tant que code avec Terraform
Outre l'API REST, Equinix propose également un fournisseur Terraform qui permet de gérer les ressources Equinix à l'aide de l'infrastructure en tant que code. Ce fournisseur Terraform encapsule l'API Equinix et offre une méthode déclarative pour définir et gérer votre infrastructure.
Le fournisseur Terraform d'Equinix prend en charge:
- Equinix Metal - Serveurs physiques, réseau et infrastructure
- Equinix Fabric - Connexions virtuelles, routeurs infonuagiques, flux et synchronisation temporelle précise
- Network Edge - Périphériques de réseau virtuels
Pour obtenir la documentation complète, des exemples et les ressources disponibles, consultez la Documentation du fournisseur Terraform.
Références API
L'API Equinix est organisée en groupes fonctionnels versionnés. Chaque groupe fonctionnel contient un ensemble de points de terminaison d'API permettant d'effectuer des opérations liées à ce groupe.
Les références API sont fournies au format OpenAPI et incluent des informations détaillées sur chaque point de terminaison, notamment les formats de requête et de réponse, les paramètres requis et des exemples de requêtes. La documentation produit Equinix contient des liens vers la « Référence API » correspondant au produit ou service concerné.
Pour consulter la bibliothèque de toutes les références API Equinix par groupe fonctionnel, consultez le Catalogue API. Vous trouverez également des liens vers toutes les références API Equinix via l'arborescence de navigation ci-dessous. Chaque chemin d'API principal est lié à sa référence API correspondante dans cette vue.