Skip to main content

L'API d'Equinix

Equinix™ provides a RESTful HTTP API which can be reached at https://api.equinix.com/. This document describes the API and how to use it.

L'API vous permet d'interagir de manière programmatique avec vos ressources Equinix, notamment les projets, les dispositifs, 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 flux de demande.

L'interaction avec les produits Equinix par le biais de l'API nécessite :

  • Compte Equinix Customer Portal ou un fournisseur OIDC.
  • Permissions de création, de modification et de suppression spécifiques à un produit.

Flux d'autorisation des utilisateurs​

  1. Enregistrer et autoriser une application dans le portail client.

  2. Request access and refresh token information by calling the /oauth2/v1/token with the Consumer key, Consumer secret, and your user credentials.

    Diagram of the user authorization flow showing a client application obtaining an OAuth access token and refresh token from the Equinix API

  3. 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 plus détaillées, voir API Authentication.

Flux d'autorisation du jeton OIDC​

  1. Create an OIDC Provider in either the Customer Portal or the Equinix API.

  2. Request access by calling the /v1/token endpoint with your identity provider token and scope.

  1. Votre demande renvoie le jeton d'accès éphémère.

For more information, see OIDC API Authentication.

Le flux des demandes​

  1. En utilisant un jeton d'accès OAuth valide pour autoriser une demande, faites un appel à un point de terminaison de l'API avec l'en-tête d'autorisation requis.

    Diagram of the API request flow showing a client calling the API gateway, which forwards the request to Equinix APIs and returns the response

  2. La passerelle API valide la demande et appelle l'API Equinix correspondante.

  3. La réponse est reçue par la passerelle API.

  4. La réponse vous est renvoyée.

Infrastructure as Code avec Terraform​

Outre l'API REST, Equinix propose également un [fournisseur Terraform] (/terraform/) qui vous permet de gérer les ressources Equinix à l'aide de l'infrastructure en tant que code. Le fournisseur Terraform intègre l'API Equinix et fournit un moyen déclaratif de définir et de gérer votre infrastructure.

Le fournisseur Terraform d'Equinix prend en charge :

  • Equinix Metal - Serveurs nus, réseaux et infrastructure
  • Equinix Fabric - Connexions virtuelles, Cloud Router, Streams et Precision Time
  • Network Edge - Dispositifs de réseau virtuels

Pour une documentation complète, des exemples et des ressources disponibles, consultez la [Documentation du fournisseur Terraform] (/terraform/).

Références API​

L'API d'Equinix est organisée en groupes fonctionnels versionnés. Chaque groupe fonctionnel contient un ensemble de points d'accès à l'API qui vous permettent d'effectuer des opérations liées à ce groupe.

Les références API sont fournies au format OpenAPI, qui comprend des informations détaillées sur chaque point de terminaison, notamment les formats de demande et de réponse, les paramètres requis et des exemples de demandes. Dans la documentation produit d'Equinix, vous trouverez des liens vers la " Référence API " correspondant au produit ou au service dont il est question.

Pour consulter une bibliothèque de toutes les références API d'Equinix par groupes fonctionnels, consultez le Catalogue API. Vous pouvez également trouver des liens vers toutes les références API d'Equinix en utilisant l'arbre de navigation suivant. Chaque chemin d'accès principal à l'API est lié à la référence API correspondante dans cette vue.

No APIs found or available based on the current filters.

Cette page vous a-t-elle été utile ?