Accesso alle risorse protette con le variabili di ambiente

Le variabili di ambiente di Managed Runtime consentono di aggiungere variabili al processo di applicazione in esecuzione in un ambiente senza dover apportare modifiche al codice. Le variabili di ambiente vengono archiviate in maniera sicura e il loro utilizzo è ideale nei seguenti casi:

  • Chiamate a risorse di terze parti protette da chiavi API
  • Modifiche condizionali del rendering React.js

Per ulteriori informazioni, vedere Variabili di ambiente.

Usiamo una variabile d'ambiente per archiviare una chiave API utilizzata per accedere a una risorsa esterna protetta. In questo tutorial la risorsa è un sistema CMS (Content Management System) di terze parti immaginario. Aggiungeremo un handler al server Express.js in ssr.js che effettua richieste al CMS e risponde con i dati protetti. Accederemo quindi ai dati richiamando l'handler.

Per motivi di sicurezza, la chiave API richiama il CMS dal codice di lato server, non dal codice di lato client.

Prerequisiti per completare questo tutorial:

  • Ottenere l'accesso a Managed Runtime e Runtime Admin. Consultare Amministrazione in Managed Runtime
  • Avere a disposizione una chiave API per utilizzare la Managed Runtime API. Per individuare la chiave API, accedere allo strumento Runtime Admin e passare alla pagina Account Settings (Impostazioni account).
  • Detenere un ruolo di sviluppatore o amministratore nel progetto per il quale si intende impostare le variabili di ambiente. Se non si dispone dell'accesso, chiedere aiuto a qualcuno con un ruolo di amministratore Managed Runtime.

Prima di eseguire i comandi di questo tutorial, sostituire tutti i segnaposto con valori effettivi. I segnaposto sono formattati nel seguente modo: $PLACEHOLDER.

  1. Per impostare la variabile d'ambiente nella sessione corrente, aprire un terminale ed eseguire questo comando:

    • Windows: set CMS_API_KEY='my-cms-api-key'
    • Maggior parte dei sistemi operativi simili a Unix, incluso macOS: export CMS_API_KEY='my-cms-api-key'

  2. Verificare se la variabile di ambiente è impostata correttamente eseguendo:

    • Windows: echo %CMS_API_KEY%
    • Maggior parte dei sistemi operativi Unix-like, incluso macOS: echo $CMS_API_KEY

    Il comando restituisce questo output: my-cms-api-key

  3. Aggiungere questo codice JavaScript per richiamare il CMS in ssr.js:

  1. Associare l'handler a una route nel server Express.js. Successivamente, avviare il server di sviluppo utilizzando npm start. Infine, passare all'handler localmente per verificare che vengano restituiti i dati del CMS.

È consigliabile testare questi passaggi in un ambiente non di produzione prima di distribuire le modifiche nell'ambiente Production.

Prima di eseguire i comandi di questo tutorial, sostituire tutti i segnaposto con valori effettivi. I segnaposto sono formattati nel seguente modo: $PLACEHOLDER.

  1. Richiamare l'endpoint projects_target_env_var_partial_update per impostare la variabile di ambiente. In questo modo il bundle viene distribuito. Attendere la ridistribuzione dell'ambiente prima di utilizzare la chiave API nel proprio codice. Per gestire le variabili di ambiente è anche possibile usare Runtime Admin. Vedere Variabili di ambiente.
  1. Distribuire il bundle dal computer locale all'ambiente scelto.