Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Plans d’utilisation et clés d’API pour les API REST dans API Gateway
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 et commencer à limiter les requêtes vers ces API en fonction de limites et de quotas définis. Ils peuvent être définis au niveau de l’API ou de la méthode API.
Que sont les plans d’utilisation et les clés d’API ?
Un plan d’utilisation spécifie qui peut accéder à une ou plusieurs méthodes et étapes d’API déployées et définit le taux de requête cible pour commencer à limiter les requêtes. 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é.
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 mécanismes d’autorisation Lambda, des Rôles IAM ou Amazon Cognito 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 plus d’informations, consultez Configuration de clés API pour les API REST dans 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.) Le nom ne peut pas dépasser 1 024 caractères. La valeur est une chaîne alphanumérique comportant entre 20 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 définit le point cible auquel la limitation des requêtes doit commencer. Ils peuvent être définis au niveau de l’API ou de la méthode d’API.
Une limite de 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é d’API selon la configuration du plan d’utilisation.
Les limites de quota et de restriction s’appliquent aux diverses demandes de clés d’API qui sont regroupées pour toutes les étapes d’API au sein d’un plan d’utilisation.
Note
La limitation des plans d’utilisation et les quotas ne sont pas des limites strictes et sont appliquées au mieux. Dans certains cas, les clients peuvent dépasser les quotas que vous avez définis. Ne comptez pas sur les quotas de plan d’utilisation ni sur la limitation pour contrôler les coûts ou bloquer l’accès à une API. Pensez à utiliser AWS Budgets pour contrôler les coûts et AWS WAF pour gérer les demandes d'API.
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.
Important
-
N’utilisez pas de clés d’API pour l’authentification ou l’autorisation pour contrôler l’accès à 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. Pour contrôler l’accès à votre API, utilisez plutôt un rôle IAM, un Mécanisme d’autorisation Lambda ou un Groupe d’utilisateurs Amazon Cognito.
-
Utilisez les clés d’API générées par API Gateway. Les clés d’API ne doivent pas inclure d’informations confidentielles ; les clients les transmettent généralement dans des en-têtes qui peuvent être enregistrés.
-
Si vous utilisez un portail pour développeurs pour publier vos API, notez que les clients peuvent s’abonner à toutes les API d’un plan d’utilisation donné, même si vous ne les avez pas rendues visibles pour eux.
-
Dans certains cas, les clients peuvent dépasser les quotas que vous avez définis. Ne vous fiez pas aux plans d’utilisation pour contrôler les coûts. Pensez à utiliser AWS Budgets pour contrôler les coûts et AWS WAF pour gérer les demandes d’API.
-
Une fois que vous avez ajouté une clé d’API à un plan d’utilisation, l’opération de mise à jour peut prendre quelques minutes.
