L'API d'Equinix
Equinix™ fournit un API HTTP RESTful accessible à l'adresse https://api.equinix.com/. Ce document décrit le API et son utilisation.
Le API vous permet d'interagir par programmation avec vos ressources Equinix, y compris les projets, les appareils, les connexions, les commandes, déploiements Colocation, tickets d'assistance et gestion des identités et des accès.
Utiliser l'API d'Equinix
L'utilisation de l'API peut être décomposée en flux d'autorisation et flux de demande.
L'interaction avec les produits Equinix via l'API nécessite :
- Ou un fournisseur OIDC Equinix Customer Portal.
- Permissions de création, de modification et de suppression spécifiques à un produit.
Flux d'autorisation des utilisateurs
-
Enregistrez et autorisez une application dans le portail client.
-
Demandez l'accès et actualisez les informations du jeton en appelant le système
/oauth2/v1/tokenavec la clé Client, le secret Client et vos identifiants utilisateur.
-
Votre demande vous renvoie le jeton d'accès OAuth éphémère et le jeton de rafraîchissement qui lui est associé.
Pour plus d'informations et des instructions détaillées, consultez authentification API .
Flux d'autorisation du jeton OIDC
-
Créez un fournisseur OIDC dans le Portail client ou dans Equinix API.
-
Demandez un accès en appelant le
/v1/tokenterminal avec votre jeton de fournisseur d'identité et votre périmètre.
- Votre demande renvoie le jeton d'accès éphémère.
Pour plus d'informations, consultez authentification API OIDC .
Le flux des demandes
-
En utilisant un jeton d'accès OAuth valide pour autoriser une demande, faites un appel à un point de terminaison API avec l'en-tête d'autorisation requis.
-
La passerelle API valide la demande et appelle l'API Equinix appropriée.
-
La réponse est reçue par la passerelle API.
-
La réponse vous est renvoyée.
Infrastructure as Code avec Terraform
En plus du API REST, Equinix fournit également un fournisseur Terraform qui vous permet de gérer les ressources Equinix en utilisant l'infrastructure comme code. Le fournisseur Terraform enveloppe le Equinix API et fournit un moyen déclaratif de définir et de gérer votre infrastructure.
Le fournisseur Terraform d'Equinix prend en charge :
- Equinix Fabric - connexions virtuelles, routeurs cloud, flux et temps de précision
- Network Edge - périphériques réseau virtuels
Pour obtenir une documentation complète, des exemples et les ressources disponibles, consultez la documentation du fournisseur Terraform .
Références API
Le Equinix API est organisé en groupes fonctionnels versionnés. Chaque groupe fonctionnel contient un ensemble de noeuds finaux API qui vous permettent d'effectuer des opérations liées à ce groupe.
Les références API sont fournies au format OpenAPI qui inclut des informations détaillées sur chaque point de terminaison, y compris les formats de demande et de réponse, les paramètres requis et les exemples de demandes. Dans toute la documentation produit Equinix, vous trouverez des liens vers la « référence API » correspondant au produit ou service discuté.
Pour afficher une bibliothèque de toutes les références Equinix API par groupes fonctionnels, consultez le catalogue API . Vous pouvez également trouver des liens vers toutes les références Equinix API à l'aide de l'arborescence de navigation suivante. Dans cette vue, chaque chemin API principal est lié à sa référence API correspondante.