OAuth 2.0 : configurer un nouveau proxy d'API

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Si vous utilisez la version Apigee Cloud d'Edge, vous constaterez qu'un proxy appelé oauth est inclus par défaut dans votre organisation. Ce proxy fournit deux exemples de points de terminaison pour générer des jetons d'accès et d'actualisation. Pour en savoir plus sur les points de terminaison des jetons OAuth, consultez la page Comprendre les points de terminaison OAuth.

Le type d'octroi d'identifiants clients définit une procédure permettant d'émettre des jetons d'accès en échange d'identifiants d'application. Ces identifiants d'application constituent la paire clé/code secret client qu'Apigee Edge émet pour chaque application enregistrée dans une organisation. Pour en savoir plus, consultez la section Mettre en œuvre le type d'octroi de code d'autorisation.

Ajouter OAuth 2.0 à un nouveau proxy d'API

Vous pouvez facilement ajouter la validation OAuth à une API lorsque vous créez un proxy d'API.

Périphérie

Pour ajouter la validation OAuth à une API à l'aide de l'interface utilisateur Edge:

  1. Connectez-vous à apigee.com/edge.
  2. Sélectionnez Développer > Proxys API dans la barre de navigation de gauche.
  3. Cliquez sur +Proxy.
  4. Utilisez l'assistant de création de proxy pour créer un proxy inverse. Consultez la section Créer un proxy d'API simple.
  5. Sur la page Règles communes de l'assistant, sélectionnez la case d'option OAuth v2.0.

Classic Edge (cloud privé)

Pour ajouter la validation OAuth à une API à l'aide de l'interface utilisateur Classic Edge:

  1. Connectez-vous à http://ms-ip:9000, où ms-ip correspond à l'adresse IP ou au nom DNS du nœud du serveur de gestion.
  2. Sélectionnez API > Proxies d'API dans la barre de navigation supérieure.
  3. Cliquez sur + Proxy d'API.
  4. Utilisez l'assistant de création de proxy pour créer un proxy inverse. Consultez la section Créer un proxy d'API simple.
  5. Sur la page Sécurité de l'assistant, sélectionnez la case d'option OAuth v2.0.

Lorsque vous sélectionnez cette option, deux règles sont associées au nouveau proxy d'API, l'une pour valider les jetons d'accès et l'autre pour supprimer le jeton d'accès après sa validation.

Notez que la case à cocher Publier le produit d'API devient sélectionnable et est automatiquement sélectionnée. Cochez cette option si vous souhaitez générer automatiquement un produit lorsque vous créez le proxy d'API. Le produit généré automatiquement sera créé avec une association au nouveau proxy d'API. Si vous avez un produit existant auquel vous souhaitez associer cette nouvelle API, assurez-vous de décocher cette case afin de ne pas créer de produit inutile. Pour plus d'informations sur les produits, consultez la section Qu'est-ce qu'un produit API ?

Utiliser le proxy OAuth par défaut

Le proxy oauth expose l'URI de point de terminaison suivant :

/oauth/client_credential/accesstoken

Publiez cet URI pour les développeurs qui ont besoin de jetons d'accès. Les développeurs d'applications configurent leurs applications pour appeler ce point de terminaison, en présentant leurs paires clé/code secret client pour obtenir des jetons d'accès.

Le point de terminaison du jeton d'identifiants clients par défaut est exposé sur le réseau à l'URL suivante :

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

Par exemple, si le nom de votre organisation est "apimakers", l'URL se présentera comme suit :

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

Il s'agit de l'URL que les développeurs appellent pour obtenir des jetons d'accès.

Appeler l'API

Lorsque vous récupérez un jeton d'accès, vous pouvez appeler l'API avec un en-tête d'autorisation et un jeton de support, comme suit :

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

Consultez également la section Vérifier les jetons d'accès.