Création et utilisation de plans d'utilisation avec des clés d'API - Amazon API Gateway

Création et utilisation de plans d'utilisation avec des clés d'API

Après avoir créé, testé et déployé vos API, vous pouvez proposer les plans d'utilisation API Gateway en tant qu'offres de produits à vos clients. Vous pouvez configurer des plans d'utilisation et clés d'API pour permettre aux clients d'accéder à des API sélectionnées selon les taux de requête et les quotas convenus, afin de répondre à leurs besoins métier tout en respectant leurs contraintes budgétaires. Si vous le souhaitez, vous pouvez définir des limitations de méthode par défaut pour une API ou définir des limitations pour chaque méthode d'API.

Que sont les plans d'utilisation et les clés d'API ?

Un plan d'utilisation définit qui peut accéder à une ou plusieurs méthodes et étapes d'API déployées, et dans quelle mesure et avec quelle rapidité d'accès. Le plan utilise des clés d'API afin d'identifier les clients et mesure les accès aux étapes d'API associées pour chaque clé. Il vous permet également de configurer des limitations et des quotas qui sont appliqués à chaque clé d'API client.

Les clés d'API sont des valeurs de chaînes alphanumériques que vous distribuez aux clients des développeurs d'applications pour leur accorder l'accès à l'API. Vous pouvez utiliser des clés d'API avec des plans d'utilisation ou des mécanismes d'autorisation Lambda pour contrôler l'accès à vos API. API Gateway peut générer des clés d'API pour vous, ou vous pouvez les importer à partir d'un fichier CSV. Vous pouvez générer une clé d'API dans API Gateway ou l'importer dans API Gateway à partir d'une source externe. Pour de plus amples informations, veuillez consulter Configuration des clés d'API à l'aide de la console API Gateway.

Chaque clé d'API a un nom et une valeur. (Les termes « clé d'API » et « valeur de clé d'API » sont souvent utilisés de manière interchangeable.) La valeur est une chaîne alphanumérique comportant entre 30 et 128 caractères, par exemple, apikey1234abcdefghij0123456789.

Important

Les valeurs de clés d'API doivent être uniques. Si vous tentez de créer deux clés d'API nommées différemment mais avec la même valeur, API Gateway les considère comme une seule et même clé d'API.

Une clé d'API peut être associée à plusieurs plans d'utilisation. Un plan d'utilisation peut être associé à plusieurs étapes. Toutefois, une clé d'API donnée ne peut être associée qu'à un seul plan d'utilisation pour chaque étape de votre API.

Une limitation est une limite de taux de demandes qui est appliquée à chaque clé d'API que vous ajoutez au plan d'utilisation. Vous pouvez aussi définir des limitations de méthode par défaut pour une API ou définir des limitations pour chaque méthode d'API.

Un quota détermine le nombre maximal de requêtes autorisées pour une clé d'API donnée sur un intervalle de temps spécifié. Vous pouvez configurer les méthodes d'API pour exiger une autorisation de clé API selon la configuration du plan d'utilisation. Vous pouvez également utiliser la commande de l'interface de ligne de commande get-usage ou la méthode de l'API REST usage:get afin de déterminer l'utilisation d'un client d'API.

Note

Les limites de quota et de restriction s'appliquent aux diverses demandes de clés API qui sont regroupées pour toutes les étapes d'API au sein d'un plan d'utilisation.

Bonnes pratiques concernant les clés d'API et les plans d'utilisation

Voici quelques suggestions de bonnes pratiques à suivre lors de l'utilisation de clés d'API et de plans d'utilisation.

  • Ne vous fiez pas aux seules clés d'API comme méthodes d'authentification et d'autorisation pour vos API. En effet, si vous utilisez plusieurs API dans un plan d'utilisation, un utilisateur doté d'une clé valide pour une API dans ce plan d'utilisation peut accéder à toutes les API dudit plan d'utilisation. Utilisez plutôt un rôle IAM, un mécanisme d'autorisation Lambda ou un groupe d'utilisateurs Amazon Cognito.

  • Si vous utilisez un portail pour développeurs afin de publier vos API, notez que toutes les API dans un plan d'utilisation donné peuvent faire l'objet d'un abonnement, même si vous ne les avez pas rendues visibles pour vos clients.