Authentification des utilisateurs de l'API

Les API d'Equinix utilisent le protocole OAuth 2.0 pour authentifier les requêtes que vous adressez aux points de terminaison de l'API. Pour interagir avec les API Equinix, vous avez besoin d'un jeton d'accès porteur. Ce jeton détermine le type de schéma d'authentification et fait partie du protocole OAuth 2.0.

info

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

Préalable

L'interaction avec les produits Equinix via une API nécessite:

• Un compte sur le portail client Equinix.
• Autorisations de création, de modification et de suppression propres au produit. Contactez l'administrateur principal de votre organisation et demandez les autorisations d'accès.

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

Un identifiant client et une clé secrète sont nécessaires pour obtenir les jetons autorisant vos requêtes API. Pour générer un identifiant client et une clé secrète, enregistrez votre application dans la section « Paramètres développeur » du portail client.

Pour enregistrer une application:

1. Connectez-vous au Portail client.

2. Dans le menu de navigation global, sélectionnez Paramètres pour développeurs > Apps pour afficher les détails de l'application.

   

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

   

   Une fois que vous aurez accepté l'accord, vous le trouverez dans la section Renseignements supplémentaires.

   

4. Cliquez sur Créer une nouvelle application.

   

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

   

6. Cliquez sur la vignette de votre application pour ouvrir ses détails.

7. Cliquez sur l'icône en forme d'œil pour afficher votre Clé Consommateur et votre Secret Consommateur.

   

Demande d'un jeton d'accès

Un jeton d'accès est requis pour autoriser vos requêtes API. Pour faire la demande, envoyez une requête POST au point de terminaison /oauth2/v1/token, en spécifiant votre identifiant 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.

Exemple de réponse:

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

Mise à jour d'un jeton

Vous pouvez actualiser 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 la liste complète des paramètres et options disponibles, consultez la référence de l'API.

Utilisation des jetons d'accès

Pour interagir avec l'API Equinix, envoyez votre jeton d'accès dans l'en-tête Authorization de la requête HTTP avec authorization: Bearer <token>.

Exemple de requête cURL - un envoi entrant depuis 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  
    }  
}'‌