Acceso a recursos protegidos con variables de entorno

Las variables de entorno de Managed Runtime permiten agregar variables al proceso de la aplicación que se ejecuta en un entorno, sin tener que realizar cambios en el código. Las variables de entorno se almacenan de forma segura, lo que hace que sean ideales casos de uso como los siguientes:

  • Llamar a recursos de terceros que están protegidos por claves de API
  • Cambiar condicionalmente la representación React.js

Para obtener más información, consulte Variables deentorno.

Usemos una variable de entorno para almacenar una clave de API utilizada para acceder a un recurso externo seguro. En este tutorial, el recurso es un sistema de administración de contenido (CMS) imaginario de terceros. Agregaremos un controlador al servidor ssr.js Express.js que realiza solicitudes al CMS y responde con los datos protegidos. A continuación, accedemos a los datos llamando al controlador.

Por razones de seguridad, la clave API llama al CMS desde el código del lado del servidor, no desde el código del lado del cliente.

Para completar este tutorial, primero:

  • Obtenga acceso a Managed Runtime y Runtime Admin. Administración de Managed Runtime
  • Tener una clave de API para usar la API de Managed Runtime. Para encontrar su clave de API, inicie sesión en la herramienta Runtime Admin y vaya a la página Configuración de la cuenta.
  • Tenga un rol de desarrollador o administrador en el proyecto para el que está configurando variables de entorno. Si no tienes acceso, pídele a alguien con un rol de administrador de Managed Runtime que te ayude con eso.

Antes de ejecutar los comandos de este tutorial, reemplace los marcadores de posición por valores reales. Los marcadores de posición tienen el siguiente formato: $PLACEHOLDER.

  1. Para establecer la variable de entorno en la sesión actual, abra un terminal y ejecute este comando:

    • Windows: set CMS_API_KEY='my-cms-api-key'
    • La mayoría de los sistemas operativos similares a Unix, incluido macOS: export CMS_API_KEY='my-cms-api-key'

  2. Compruebe si la variable de entorno está configurada correctamente ejecutando:

    • Windows: echo %CMS_API_KEY%
    • La mayoría de los sistemas operativos similares a Unix, incluido macOS: echo $CMS_API_KEY

    El comando devuelve este resultado: my-cms-api-key

  3. Agregue este código JavaScript para llamar al CMS en ssr.js:

  1. Enlazar el controlador a una ruta en el servidor Express.js. A continuación, inicie el servidor de desarrollo con npm start. Finalmente, navegue hasta el controlador localmente para verificar que se devuelvan los datos de CMS.

Se recomienda probar estos pasos en un entorno que no sea de producción antes de implementar los cambios en producción.

Antes de ejecutar los comandos de este tutorial, reemplace los marcadores de posición por valores reales. Los marcadores de posición tienen el siguiente formato: $PLACEHOLDER.

  1. Llame al punto de projects_target_env_var_partial_update conexión para establecer la variable de entorno. De este modo, se implementa el paquete. Espere a que el entorno se vuelva a implementar antes de usar la clave de API en el código. También puede usar Runtime Admin para administrar variables de entorno. Consulte Variables de entorno.
  1. Implemente el paquete desde el equipo local en el entorno elegido.