Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
O módulo apigee-access permite acessar caches e variáveis de fluxo do proxy de API
no código do aplicativo Node.js. O módulo está incluído na plataforma Apigee Edge. Você não precisa
instalá-lo como faria com outros módulos Node.js.
Como receber o acesso da Apigee
O módulo apigee-access está integrado à plataforma Apigee Edge. Quando você
implanta o código Node.js no Edge, esse módulo fica disponível. Você só precisa dela em qualquer código Node.js que implantar. Exemplo:
var access=require('apigee-access');
Como acessar variáveis de fluxo
Ao implantar um aplicativo Node.js no Edge, é possível acessar qualquer uma das variáveis de fluxo "prontas para uso" compatíveis, variáveis de fluxo criadas por políticas e quaisquer variáveis de fluxo criadas por você a partir do seu código Node.js. As variáveis de fluxo são criadas e existem no contexto de um proxy de API em execução no Edge. Para informações detalhadas, consulte Como acessar variáveis de fluxo no Node.js.
Como acessar o cache
O módulo apigee-access permite acessar o cache distribuído do Apigee Edge pelo
código Node.js. Para informações detalhadas, consulte Como acessar o cache no Node.js.
Como usar o serviço de cotas
O módulo apigee-access permite acessar o serviço de cota do Apigee Edge pelo
código Node.js. Para informações detalhadas, consulte Como acessar o serviço de cota no Node.js.
Acessar mapas de chave-valor
O módulo apigee-access permite acessar mapas de chave-valor (KVMs) do Apigee Edge a partir
do código Node.js. Para informações detalhadas, consulte Como acessar mapas de chave-valor no Node.js.
Como executar no modo local x no modo implantado
Para oferecer suporte ao desenvolvimento e testes locais, o módulo apigee-access
funciona em um modo local sem dependências no Apigee Edge. No entanto,
quando o módulo é usado com um proxy de API que é implantado no
Edge, a funcionalidade "local" é substituída pela funcionalidade nativa do Edge. Por exemplo, o complemento completo das variáveis de fluxo pode ser acessado no modo implantado, enquanto apenas um pequeno subconjunto está disponível quando você executa o aplicativo Node.js localmente. Para ver uma lista dessas variáveis de modo local, consulte Como executar no modo local.
Como determinar o modo em que o módulo está sendo executado
Para determinar em qual modo você está executando o apigee-access:
var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());
O valor de retorno de getMode() informa se o aplicativo Node.js está ou não implantado no Apigee Edge ou está sendo executado no modo autônomo. O método retorna um destes dois resultados de string:
apigee: o aplicativo Node.js está em execução na Apigee Edge e tem suporte para todas as funcionalidades.standalone: o aplicativo Node.js está sendo executado fora do ambiente do Apigee Edge, e a funcionalidade padrão descrita na parte superior do documento entra em vigor.
Como executar no modo implantado
Quando implantadas no Edge, as variáveis definidas por políticas ficam visíveis para apigee-access, e as variáveis adicionadas ou modificadas pelos métodos deste módulo ficam visíveis para as políticas subsequentes no fluxo de proxy.
Você encontra o link das variáveis compatíveis na Referência de variáveis. Essas variáveis, bem como aquelas que você criar com seus próprios nomes, são visíveis para apigee-access. Observe
que algumas variáveis são somente leitura. Elas são identificadas na Referência de variáveis.
Como executar no modo local
No "modo local", você executa o código Node.js fora do contexto da Apigee Edge. Nesse modo, a maioria das variáveis de fluxo predefinidas não é acessível no código Node.js. Esta tabela mostra o pequeno subconjunto de variáveis de fluxo disponíveis. Essas variáveis são aceitas aqui para dar suporte ao desenvolvimento e ao teste local de aplicativos Node.js para o Apigee Edge.
| Variável | Somente leitura | Tipo | Observações |
client.received.start.time |
Sim | String | Hora em que a solicitação foi recebida |
client.received.end.time |
Sim | String | Hora em que a solicitação foi recebida |
client.received.start.timestamp |
Sim | Número inteiro | Hora em que a solicitação foi recebida |
client.received.end.timestamp |
Sim | Número inteiro | Hora em que a solicitação foi recebida |
Novamente, a plataforma Apigee Edge oferece suporte a um conjunto muito maior de variáveis predefinidas. Consulte a Referência de variáveis do Apigee Edge para ver a lista completa.