Acessar recursos protegidos com variáveis de ambiente

As variáveis de ambiente do Managed Runtime permitem que você adicione variáveis ao processo do aplicativo em execução em um ambiente, sem precisar fazer alterações no código. Elas são armazenadas com segurança, o que as torna ideais para os seguintes casos de uso:

  • Chamar recursos de terceiros protegidos por chaves de API
  • Alterar condicionalmente a renderização de React.js

Para obter mais detalhes, consulte Variáveis de ambiente.

Vamos usar uma variável de ambiente para armazenar uma chave de API usada para acessar um recurso externo seguro. Neste tutorial, o recurso é um sistema de gerenciamento de conteúdo (CMS) imaginário de terceiros. Adicionaremos um manipulador ao servidor Express.js em ssr.js que faz solicitações ao CMS e responde com os dados protegidos. Em seguida, acessamos os dados chamando o manipulador.

Por motivos de segurança, a chave API chama o CMS do código no lado do servidor, não do código no lado do cliente.

Para concluir este tutorial, primeiro:

  • Obtenha acesso ao Managed Runtime e ao Runtime Admin. Consulte Administração do Managed Runtime
  • Tenha uma chave de API para usar a Managed Runtime API. Para encontrar a chave de API, faça logon na ferramenta Runtime Admin e vá para a página Configurações de conta.
  • Ter uma função de desenvolvedor ou administrador no projeto para o qual você está definindo variáveis de ambiente. Se você não tiver acesso, peça ajuda a alguém em uma função de administrador do Managed Runtime.

Antes de executar os comandos neste tutorial, substitua os espaços reservados por valores reais. Os espaços reservados são formatados da seguinte maneira: $PLACEHOLDER.

  1. Para definir a variável de ambiente na sessão atual, abra um terminal e execute este comando:

    • Windows: set CMS_API_KEY='my-cms-api-key'
    • Maioria dos sistemas operacionais do tipo Unix, incluindo o macOS: export CMS_API_KEY='my-cms-api-key'

  2. Verifique se a variável de ambiente está definida corretamente executando:

    • Windows: echo %CMS_API_KEY%
    • Maioria dos sistemas operacionais do tipo Unix, incluindo o macOS: echo $CMS_API_KEY

    O comando retorna esta saída: my-cms-api-key

  3. Adicione este código JavaScript para chamar o CMS em ssr.js:

  1. Vincule o manipulador a uma rota no servidor Express.js. Em seguida, inicie o servidor de desenvolvimento usando npm starto . Finalmente, navegue até o manipulador localmente para verificar se os dados CMS são retornados.

Recomendamos testar essas etapas em um ambiente que não seja de produção antes de implantar suas alterações na produção.

Antes de executar os comandos neste tutorial, substitua os espaços reservados por valores reais. Os espaços reservados são formatados da seguinte maneira: $PLACEHOLDER.

  1. Chame o endpoint projects_target_env_var_partial_update para definir a variável de ambiente. Isso implanta seu pacote. Aguarde a reimplantação do ambiente antes de usar a chave de API em seu código. Você também pode usar o Runtime Admin para gerenciar variáveis de ambiente. Consulte Variáveis de ambiente.
  1. Implante o pacote da máquina local no ambiente escolhido.