Authentification de l'utilisateur API

Les API d'Equinix utilisent le protocole OAuth 2.0 pour authentifier les demandes que vous faites aux points d'extrémité de l'API. Pour interagir avec les API d'Equinix, vous avez besoin d'un jeton d'accès au porteur. Le support détermine le type de schéma d'authentification et fait partie du protocole OAuth 2.0.

info

L'API Metal d'Equinix n'utilise pas le flux d'authentification décrit ici. Les clés de l'API Metal sont gérées via la console Metal, et son authentification est documentée dans la Référence API.

Conditions préalables

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

• Un compte Equinix Customer Portal.
• Autorisations de création, de modification et de suppression spécifiques à un produit. Contactez l'administrateur principal de votre organisation et demandez des autorisations d'accès.

Générer l'identifiant et le secret du client

Un identifiant et un secret client sont nécessaires pour obtenir des jetons qui autorisent vos demandes d'API. Pour générer un identifiant et un secret client, enregistrez votre application dans la section Developer Settings du portail client.

Pour enregistrer une application :

1. Connectez-vous au [Customer Portal] (https://portal.equinix.com).

2. Dans le menu de navigation global, sélectionnez Developer Settings > Apps pour afficher les détails de l'application.

   

3. Accord de licence API - Avant d'utiliser la plateforme et les API pour la première fois, vous devez lire et accepter l'accord de licence API affiché.

   

   Une fois que vous avez accepté l'accord, vous le trouverez dans la section Informations complémentaires.

   

4. Cliquez sur Create New App.

   

5. Indiquez un nom d'application, sélectionnez type d'environnement d'application (Production) et cliquez sur Créer.

   

6. Cliquez sur la tuile de votre application pour en ouvrir les détails.

7. Cliquez sur l'icône de l'œil pour afficher votre Consumer Key et votre Consumer Secret.

   

Demander un jeton d'accès

Un jeton d'accès est nécessaire pour autoriser vos demandes d'API. Pour demander un jeton, envoyez une requête POST au point de terminaison /oauth2/v1/token, en spécifiant votre ID client et votre Secret client dans le corps de la requête.

Exemple de requête cURL :

curl -X  
POST 'https://api.equinix.com/oauth2/v1/token'  
-H 'content-type: application/json'  
-d '{  
    "grant_type": "client_credentials",  
    "client_id": "<client_id>",  
    "client_secret": "<client_secret>"  
}'

Pour une liste complète des paramètres et options disponibles, consultez la [Référence API] (/api-catalog/accesstokenv1#operation/GetOAuth2AccessToken).

Exemple de réponse :

{  
    "access_token": "<token>",  
    "token_timeout": "3600",  
    "user_name": "john.doe@example.com",  
    "token_type": "Bearer"  
}

Actualisation d'un jeton

Vous pouvez rafraîchir votre jeton d'accès en envoyant une requête POST au point de terminaison /oauth2/v1/refreshaccesstoken.

Exemple de requête curl :

curl -X  
POST 'https://api.equinix.com/oauth2/v1/refreshaccesstoken'  
-H 'content-type: application/json'  
-d '{  
    "client_id": "<client_id>",  
    "client_secret": "<client_secret>",  
    "refresh_token": "<token>  
}'‌‌

Pour obtenir une liste complète des paramètres et options disponibles, consultez la Référence API.

Utilisation de jetons d'accès

To interact with Equinix API, send your access token in the Authorization header of the HTTP request with authorization: Bearer <token>

Exemple de requête cURL - un envoi entrant de l'API de colocation :

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/shipments"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "type": "INBOUND",  
    "requestedDateTime": "2020-11-02T10:45:41Z",  
    "cageId": "AM1:01:000111",  
    "details": {  
    "carrier": "CUSTOMER_CARRIER",  
    "numberOfBoxes": 2  
    }  
}'‌