Plans d'utilisation et API clés pour REST APIs in API Gateway

Après avoir créé, testé et déployé votreAPIs, vous pouvez utiliser les plans d'utilisation de API Gateway pour les rendre disponibles sous forme d'offres de produits pour vos clients. Vous pouvez configurer des plans d'utilisation et des API clés pour permettre aux clients d'accéder à une sélectionAPIs, et commencer à limiter les demandes à ces derniers en APIs fonction de limites et de quotas définis. Ils peuvent être définis au niveau de la API API méthode ou de la méthode.

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

Un plan d'utilisation indique qui peut accéder à une ou plusieurs API étapes et méthodes déployées et définit éventuellement le taux de demandes cible pour commencer à limiter les demandes. Le plan utilise des API clés pour identifier les API clients et les personnes pouvant accéder aux API étapes associées à chaque clé.

APIles clés sont des valeurs de chaîne alphanumériques que vous distribuez aux clients développeurs d'applications pour leur accorder l'accès à votreAPI. Vous pouvez utiliser des API clés conjointement avec des autorisateurs Lambda, des IAM rôles ou Amazon Cognito pour contrôler l'accès à votre. APIs APIGateway peut générer des API clés en votre nom ou vous pouvez les importer à partir d'un CSVfichier. Vous pouvez générer une API clé dans API Gateway ou l'importer dans API Gateway à partir d'une source externe. Pour plus d’informations, consultez Configuration des API clés à l'aide de la console API Gateway.

Une API clé possède un nom et une valeur. (Les termes « API clé » et « valeur API clé » 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

APIles valeurs clés doivent être uniques. Si vous essayez de créer deux API clés portant des noms différents et la même valeur, API Gateway considère qu'il s'agit de la même API clé.

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

Une limitation définit le point cible auquel la limitation des requêtes doit commencer. Cela peut être défini au niveau de la API méthode API ou.

Une limite de quota définit le nombre maximal cible de demandes avec une API clé donnée qui peuvent être soumises dans un intervalle de temps spécifié. Vous pouvez configurer des API méthodes individuelles pour exiger une autorisation API clé en fonction de la configuration du plan d'utilisation.

Les limites de limitation et de quota s'appliquent aux demandes de API clés individuelles qui sont agrégées à toutes les API étapes 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 vous fiez pas aux quotas ou à la limitation du plan d'utilisation pour contrôler les coûts ou bloquer l'accès à un. API Envisagez AWS Budgetsde l'utiliser pour surveiller les coûts et AWS WAFgérer les API demandes.

Bonnes pratiques en matière de API clés et de plans d'utilisation

Vous trouverez ci-dessous des suggestions de bonnes pratiques à suivre lors de l'utilisation de API clés et de plans d'utilisation.

Important

• N'utilisez pas de API clés d'authentification ou d'autorisation pour contrôler l'accès à votreAPIs. Si vous en avez plusieurs APIs dans un plan d'utilisation, un utilisateur possédant une API clé valide pour l'une d'entre elles API dans ce plan d'utilisation peut accéder à l'ensemble APIs de ce plan d'utilisation. Pour contrôler l'accès à votre compteAPI, utilisez plutôt un IAM rôle, un autorisateur Lambda ou un groupe d'utilisateurs Amazon Cognito.

• Utilisez API les clés générées par API Gateway. APIles clés 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 votreAPIs, notez que les clients peuvent souscrire à tous vos abonnements inclus APIs dans un plan d'utilisation donné, même si vous ne les avez pas rendus visibles à vos clients.

• 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. Envisagez AWS Budgetsde l'utiliser pour surveiller les coûts et AWS WAFgérer les API demandes.

• Après avoir ajouté une API clé à un plan d'utilisation, l'opération de mise à jour peut prendre quelques minutes.