OAuth 2.0 : configurer un nouveau proxy d'API

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

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 sont la clé client et le code secret qu'Apigee é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 v2.0 à un nouveau proxy d'API

Vous pouvez ajouter la validation OAuth à une API lorsque vous créez un proxy d'API dans l'interface utilisateur d'Apigee.

Pour ajouter la validation OAuth à une API, procédez comme suit :

Apigee dans la console Cloud

  1. Dans la console Google Cloud , accédez à la page Développement de proxys > Proxys d'API.

    Accéder aux proxys d'API

  2. Sélectionnez votre organisation dans le sélecteur de projet du volet Google Cloud . Le nom de l'organisation est identique à celui de votre projet Google Cloud .
  3. Dans le volet Proxys d'API, cliquez sur + Créer.
  4. Dans le volet Créer un proxy, sous Modèle de proxy, sélectionnez Proxy inverse (le plus courant).
  5. Configurez le proxy comme suit :
    Nom Valeur
    Proxy Name (Nom du proxy) helloworld_oauth2
    Base Path (Chemin de base)

    /hellooauth2

    Le chemin de base du projet fait partie de l'URL utilisée pour envoyer des requêtes au proxy d'API.
    Description hello world protected by OAuth v2.0
    Cible (API existante)

    https://mocktarget.apigee.net/ip

    Cela définit l'URL cible qu'Apigee appelle pour une requête adressée au proxy d'API. Cette cible renvoie une réponse simple : Hello, Guest!.
  6. Cliquez sur Suivant.
  7. Déployer (facultatif) :
    • Environnements de déploiement : facultatif. Cochez les cases pour sélectionner un ou plusieurs environnements dans lesquels déployer votre proxy. Si vous préférez ne pas déployer le proxy à ce stade, laissez le champ Environnements de déploiement vide. Vous pourrez toujours déployer le proxy ultérieurement.
    • Compte de service : facultatif. Associez un compte de service à votre déploiement pour permettre à votre proxy d'accéder aux services Google Cloud, comme spécifié dans le rôle et les autorisations du compte de service.
  8. Cliquez sur Créer.
  9. Dans le volet Résumé du proxy du proxy helloworld_apikey, cliquez sur l'onglet Développer.
  10. Dans le menu Règles, cliquez sur Ajouter une règle.
  11. Dans le volet Créer une règle, sous Sécurité, sélectionnez Vérifier la clé API.
  12. Dans le volet Valider la clé API, renseignez les champs obligatoires des sections Nom et Nom à afficher en utilisant les valeurs suivantes :
    • Nom : saisissez un nom de règle. Par exemple, VerifyAPIKey.
    • Nom à afficher : saisissez le nom de la règle à utiliser dans l'interface utilisateur. Exemple :Verify API Key
  13. Cliquez sur Créer.
  14. Cliquez sur  pour ajouter une autre règle.
  15. Dans le volet Créer une règle, sous Médiation, sélectionnez Attribuer un message.
  16. Dans le volet Attribuer un message, renseignez les champs obligatoires des sections Nom et Nom à afficher à l'aide des valeurs suivantes :
    • Nom : saisissez un nom de règle. Par exemple, AssignMessage.
    • Nom à afficher : saisissez le nom de la règle à utiliser dans l'interface utilisateur. Exemple :Assign Message
  17. Cliquez sur Créer.

  18. Mettez à jour le contenu de la règle Assign Message (Attribuer un message) comme suit :

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. Ajoutez les règles VerifyApiKey et Remove Header Authorization.
    1. Dans le menu Proxy endpoints (Points de terminaison du proxy), cliquez sur Preflow (PreFlow).
    2. Dans le volet Requête de l'éditeur visuel, cliquez sur Ajouter une étape de stratégie.
    3. Dans le volet Ajouter une étape de règle, sélectionnez Vérifier la clé API.
    4. Cliquez sur Ajouter.
    5. Dans le volet Requête de l'éditeur visuel, cliquez sur Ajouter une étape de stratégie.
    6. Dans le volet Ajouter une étape de règle, sélectionnez Supprimer l'autorisation d'en-tête.
    7. Cliquez sur Ajouter.
  20. Cliquez sur Enregistrer.

UI classique

  1. Connectez-vous à l'UI Apigee.
  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 à côté de OAuth v2.0.
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 ?