Restreindre l'accès à l'API avec des clés API

Les clés API vous permettent de restreindre l'accès à certaines méthodes d'une API ou à l'ensemble de ses méthodes. Cette page explique comment restreindre l'accès à une API aux seuls clients disposant de la clé API correspondante, ainsi que comment créer une clé API.

Le proxy Extensible Service Proxy (ESP) utilise l'API Service Control pour valider une clé API et son association avec une API active d'un projet. Si vous configurez une exigence de clé API dans votre API, toute requête concernant la méthode, la classe ou l'API ainsi protégées est rejetée, sauf si elle est assortie d'une clé générée au sein de votre projet ou dans un autre projet appartenant à un développeur auquel vous avez donné l'autorisation d'activer cette API. Le projet dans lequel la clé API a été créée n'est ni consigné, ni ajouté à l'en-tête de la requête. Toutefois, vous pouvez afficher le projet Google Cloud auquel un client est associé dans Endpoints > Services, comme décrit dans la section Filtrer un projet pour un consommateur spécifique.

Pour plus d'informations sur le projet Google Cloud dans lequel une clé API doit être créée, consultez la section Partager des API protégées par une clé API.

Restreindre l'accès à toutes les méthodes d'une API

Si vous souhaitez qu'une clé API soit exigée pour accéder à toutes les méthodes d'une API :

  1. Ouvrez le fichier openapi.yaml de votre projet dans un éditeur de texte.

  2. Sous securityDefinitions:, ajoutez les valeurs api_key: apiKey, keyet query, comme indiqué dans l'exemple d'extrait de code ci-dessous :

    securityDefinitions:
      # This section configures basic authentication with an API key.
      api_key:
        type: "apiKey"
        name: "key"
        in: "query"

    Cela établit un "schéma de sécurité" appelé api_key que vous pouvez utiliser pour protéger l'API.

  3. En haut du fichier (il ne doit pas être en retrait ni imbriqué), ajoutez api_key: [] à la directive security. Vous devrez peut-être ajouter la directive securityou celle-ci est peut-être déjà présente :

      security:
        - api_key: []
    

    Cette directive applique le schéma de sécurité api_key à toutes les méthodes du fichier. Ne placez rien dans les crochets. La spécification OpenAPI nécessite une liste vide pour les schémas de sécurité qui n'utilisent pas l'authentification OAuth.

Restreindre l'accès à certaines méthodes de l'API

Si vous souhaitez qu'une clé API soit exigée pour une méthode spécifique :

  1. Ouvrez le fichier openapi.yaml de votre projet dans un éditeur de texte.

  2. En haut du fichier (il ne doit pas être en retrait ni imbriqué), ajoutez une directive de sécurité vide pour l'appliquer à l'ensemble de l'API :

    security: []
    
  3. Sous securityDefinitions:, ajoutez les valeurs api_key: apiKey, keyet query, comme indiqué dans l'exemple d'extrait de code ci-dessous :

    securityDefinitions:
      # This section configures basic authentication with an API key.
      api_key:
        type: "apiKey"
        name: "key"
        in: "query"

    Cela établit un "schéma de sécurité" appelé api_key que vous pouvez utiliser pour protéger l'API.

  4. Ajoutez api_key: [] à la directive security dans la définition de la méthode :

    ...
    paths:
      "/echo":
    post:
      description: "Echo back a given message."
      operationId: "echo"
      security:
      - api_key: []
      produces:
      ...
    

    Cette directive applique le schéma de sécurité api_key à la méthode. Ne placez rien dans les crochets. La spécification OpenAPI nécessite une liste vide pour les schémas de sécurité qui n'utilisent pas l'authentification OAuth.

Supprimer la restriction de clé API pour une méthode

Pour désactiver la validation de clé API pour une méthode particulière même lorsque vous avez restreint l'accès à l'API pour l'API :

  1. Ouvrez le fichier openapi.yaml de votre projet dans un éditeur de texte.

  2. Ajoutez une directive security dans la définition de la méthode :

    ...
    paths:
      "/echo":
    post:
      description: "Echo back a given message."
      operationId: "echo"
      security: []
      produces:
      ...
    

Appeler une API à l'aide d'une clé API

Si une API ou une méthode d'API nécessite une clé API, fournissez la clé à l'aide d'un paramètre de requête nommé key, comme indiqué dans cet exemple curl :

 curl "${ENDPOINTS_HOST}/echo?key=${ENDPOINTS_KEY}"

ENDPOINTS_HOST et ENDPOINTS_KEY sont des variables d'environnement contenant le nom d'hôte de votre API et votre clé API, respectivement.

Partager des API protégées par une clé API

Les clés API sont associées au projet Google Cloud dans lequel elles ont été créées. Si vous avez décidé d'exiger une clé API pour votre API, le projet Google Cloud dans lequel la clé API est créée dépend des réponses aux questions suivantes :

  • Avez-vous besoin de distinguer les appelants de votre API pour pouvoir utiliser les fonctionnalités Endpoints comme les quotas ?
  • Est-ce que tous les appelants de votre API ont leurs propres projets Google Cloud ?
  • Avez-vous besoin de configurer différentes restrictions de clés API ?

L'arbre de décision suivant peut vous servir de guide pour choisir le projet Google Cloud dans lequel créer la clé API.

Arbre de décision relatif aux clés API

Accorder l'autorisation d'activer l'API

Lorsque vous devez faire la distinction entre les appelants de votre API et que chaque appelant dispose de son propre projet Google Cloud, vous pouvez accorder aux utilisateurs membres des projets appelants l'autorisation d'activer l'API dans leur propre projet Google Cloud. De cette manière, les utilisateurs de votre API peuvent créer leur propre clé API à utiliser avec votre API.

Par exemple, supposons que votre équipe ait créé une API à usage interne pour différents programmes clients de votre entreprise, et que chaque programme client possède son propre projet Google Cloud. Pour faire la distinction entre les appelants de votre API, la clé API de chaque appelant doit être créée dans un projet Google Cloud différent. Vous pouvez autoriser vos collègues à activer l'API dans le projet Google Cloud auquel le programme client est associé.

Pour permettre aux utilisateurs de créer leur propre clé API :

  1. Dans le projet Google Cloud dans lequel votre API est configurée, accordez à chaque utilisateur l'autorisation d'activer votre API.
  2. Contactez les utilisateurs et faites-leur savoir qu'ils peuvent activer votre API dans leur propre projet Google Cloud et créer une clé API.

Créer un projet Google Cloud distinct pour chaque appelant

Lorsque vous devez faire la distinction entre les appelants de votre API et que ceux-ci n'ont pas tous de projet Google Cloud, vous pouvez créer une clé API et un projet Google Cloud distincts pour chaque appelant. Avant de créer ces projets, réfléchissez aux noms que vous allez leur donner, afin d'être en mesure d'identifier facilement l'appelant associé à chaque projet.

Par exemple, supposons que vous ayez des clients externes pour votre API, et que vous ne sachiez pas comment les programmes clients qui appellent celle-ci ont été créés. Certains clients utilisent peut-être les services Google Cloud et possèdent donc un projet Google Cloud, alors que d'autres non. Pour faire la distinction entre les appelants, vous devez créer une clé API et un projet Google Cloud distincts pour chacun d'eux.

Pour créer une clé API et un projet Google Cloud distincts pour chaque appelant :

  1. Créez un projet distinct pour chaque appelant.
  2. Dans chaque projet, activez votre API et créez une clé API.
  3. Donnez la clé API à chaque appelant.

Créer une clé API pour chaque appelant

Lorsque vous n'avez pas besoin de distinguer les appelants de votre API, mais que vous souhaitez ajouter des restrictions de clé API, vous pouvez créer une clé API distincte pour chaque appelant du même projet.

Pour créer une clé API pour chaque appelant dans le même projet :

  1. Soit dans le projet dans lequel votre API est configurée, soit dans un projet dans lequel votre API est activée, créez pour chaque client une clé API disposant des restrictions de clés API dont vous avez besoin.
  2. Donnez la clé API à chaque appelant.

Créer une clé API pour tous les appelants

Lorsque vous n'avez pas besoin de distinguer les appelants de votre API ni d'ajouter de restrictions d'API, mais que vous souhaitez quand même qu'une clé API soit exigée (pour empêcher l'accès anonyme, par exemple), vous pouvez créer une clé API que tous les appelants peuvent utiliser.

Pour créer une clé API pour tous les appelants :
  1. Soit dans le projet dans lequel votre API est configurée, soit dans un projet dans lequel votre API est activée, créez une clé API pour tous les appelants.
  2. Donnez la même clé API à chaque appelant.

Étapes suivantes