Accéder aux ressources protégées avec des variables d\u2019environnement

Les variables d’environnement Managed Runtime vous permettent d’ajouter des variables au processus d’application exécuté dans un environnement, sans avoir à modifier le code. Les variables d’environnement sont stockées de façon sécurisée. Elles sont donc idéales pour des cas d’utilisation tels que :

  • Appels de ressources tierces protégées par des clés d’API
  • Modification conditionnelle du rendu React.js

Pour plus de détails, consultez Variables d’environnement.

Utilisons une variable d’environnement pour stocker une clé API utilisée pour accéder à une ressource externe sécurisée. Dans ce tutoriel, la ressource est un système de gestion de contenu (CMS) tiers imaginaire. Nous allons ajouter un gestionnaire au serveur Express.js dans ssr.js qui envoie des requests au CMS et répond avec les données protégées. Nous accéderons ensuite aux données en appelant le gestionnaire.

Pour des raisons de sécurité, la clé API appelle le CMS à partir du code côté serveur, et non du code côté client.

Pour suivre ce tutoriel, procédez d’abord comme suit :

  • Accédez à Managed Runtime et Runtime Admin. Voir Administration de Managed Runtime.
  • Disposez d’une clé d’API pour utiliser l’API Managed Runtime. Pour trouver votre clé d'API, connectez-vous à l'outil Runtime Admin et accédez à la page Account Settings.
  • Disposez d’un rôle de développeur ou d’administrateur sur le projet pour lequel vous définissez des variables d’environnement. Si vous n’y avez pas accès, demandez à quelqu’un disposant du rôle d’administrateur Managed Runtime (MRT) de vous aider.

Avant d’exécuter les commandes de ce tutoriel, remplacez les espaces réservés par des valeurs réelles. Les espaces réservés sont formatés ainsi : $PLACEHOLDER.

  1. Pour définir la variable d’environnement dans la session en cours, ouvrez un terminal et exécutez la commande suivante :

    • Windows : set CMS_API_KEY='my-cms-api-key'
    • La plupart des systèmes d’exploitation de type Unix, y compris macOS : export CMS_API_KEY='my-cms-api-key'

  2. Vérifiez si la variable d’environnement est correctement définie en exécutant :

    • Windows : echo %CMS_API_KEY%
    • La plupart des systèmes d’exploitation de type Unix, y compris macOS : echo $CMS_API_KEY

    La commande renvoie la sortie suivante : my-cms-api-key

  3. Ajoutez ce code JavaScript pour appeler le CMS dans ssr.js :

  1. Liez le gestionnaire à une route dans le serveur Express.js. Ensuite, démarrez le serveur de développement à l’aide de npm start. Enfin, accédez au gestionnaire localement pour vérifier que les données CMS sont renvoyées.

Nous vous recommandons de tester ces étapes dans un environnement hors production avant de déployer vos modifications en production.

Avant d’exécuter les commandes de ce tutoriel, remplacez les espaces réservés par des valeurs réelles. Les espaces réservés sont formatés ainsi : $PLACEHOLDER.

  1. Appelez le point de terminaison projects_target_env_var_partial_update pour définir la variable d’environnement. Cela déploie votre paquet. Attendez que l’environnement se redéploie avant d’utiliser la clé API dans votre code. Vous pouvez également utiliser Runtime Admin pour gérer les variables d’environnement. Voir Variables d’environnement.
  1. Déployez votre paquet à partir de votre machine locale vers l’environnement de votre choix.