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.
Configuration des API clés à l'aide de la API passerelle REST API
Pour configurer API les clés, procédez comme suit :
Configurez les API méthodes pour exiger une API clé.
Créez ou importez une API clé pour le API dans une région.
Avant de configurer API les clés, vous devez en avoir créé une API et l'avoir déployée sur une scène. Une fois que vous avez créé une valeur API clé, elle ne peut pas être modifiée.
Pour les REST API appels permettant de créer et de déployer unAPI, voir restapi:create
et deployment:create
, respectivement.
Note
Pour connaître les bonnes pratiques à prendre en compte, consultez Bonnes pratiques en matière de API clés et de plans d'utilisation.
Exiger une API clé pour une méthode
Pour exiger une API clé pour une méthode, effectuez l'une des opérations suivantes :
-
Appelez
method:put
pour créer une méthode. DéfinissezapiKeyRequired
surtrue
dans la charge utile de la demande. -
Appelez
method:update
pour définirapiKeyRequired
surtrue
.
Création ou importation de API clés
Pour créer ou importer une API clé, effectuez l'une des opérations suivantes :
-
Appelez
apikey:create
pour créer une API clé. -
Appelez
apikey:import
pour importer une API clé depuis un fichier. Pour le format de fichier, consultez APIFormat de fichier API clé de passerelle.
Vous ne pouvez pas modifier la valeur de la nouvelle API clé. Pour découvrir comment configurer un plan d'utilisation, consultez Créez, configurez et testez des plans d'utilisation à l'aide de la API passerelle CLI et REST API.