Cette page a été traduite par l'API Cloud Translation.

Utiliser le module apigee-access

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Avis d'abandon de Private Cloud:

Compatibilité avec les proxys Node.js et les coffres sécurisés

Depuis 2013, Apigee prend en charge l'utilisation de proxys Node.js dans Apigee Edge par le biais de Trireme, qui vous permet d'exécuter votre code Node.js dans Apigee Edge pour le cloud privé et de l'exposer en tant qu'API.

Apigee recommande aux clients Private Cloud de procéder comme suit:

Migrez les données stockées dans des coffres sécurisés vers des cartes clé-valeur chiffrées (KVM) pour accéder aux données sensibles à partir d'un proxy d'API.
Migrez des proxys d'API basés sur Trireme (Node.js) vers un environnement Node.js natif en dehors d'Apigee.

Consultez également Abandons et retraits d'Apigee.

Le module apigee-access vous permet d'accéder aux variables de flux proxy de l'API et aux caches à partir du code de l'application Node.js. Le module est inclus dans la plate-forme Apigee Edge. Vous n'avez pas besoin de l'installer comme vous le feriez avec d'autres modules Node.js.

Obtention de l'accès apigee

Le module apigee-access est intégré à la plate-forme Apigee Edge. Lorsque vous déployez du code Node.js dans Edge, vous avez accès à ce module. Il vous suffit de l'exiger dans le code Node.js que vous déployez. Exemple :

var access=require('apigee-access');

Accéder aux variables de flux

Lorsque vous déployez une application Node.js sur Edge, vous pouvez accéder à n'importe quelle variable de flux compatible "prête à l'emploi", à toutes les variables de flux créées par des règles et à toutes les variables de flux que vous créez vous-même à partir de votre code Node.js. Les variables de flux sont créées et existent dans le contexte d'un proxy d'API exécuté sur Edge. Pour plus d'informations, consultez la section Accéder aux variables de flux dans Node.js.

Accéder au cache

Le module apigee-access vous permet d'accéder au cache distribué Apigee Edge à partir de votre code Node.js. Pour en savoir plus, consultez la section Accéder au cache dans Node.js.

Utiliser le service de quota

Le module apigee-access vous permet d'accéder au service de quotas Apigee Edge à partir de votre code Node.js. Pour en savoir plus, consultez la page Accéder au service de quotas dans Node.js.

Accéder aux cartes clés-valeurs

Le module apigee-access vous permet d'accéder aux cartes clé-valeur (KVM) Apigee Edge à partir de votre code Node.js. Pour en savoir plus, consultez la section Accéder aux mappages de clés-valeurs dans Node.js.

Exécuter en mode local ou en mode déployé

Pour prendre en charge le développement et les tests en local, le module apigee-access fonctionne en mode local sans dépendance à Apigee Edge. Toutefois, lorsque le module est utilisé avec un proxy d'API déployé sur Edge, la fonctionnalité "locale" est remplacée par la fonctionnalité Edge native. Par exemple, l'ensemble des variables de flux est accessible en mode déployé, tandis que seul un petit sous-ensemble est disponible lorsque vous exécutez l'application Node.js en local. Pour obtenir la liste de ces variables en mode local, consultez la section Exécuter en mode local.

Déterminer le mode d'exécution du module

Pour déterminer le mode dans lequel vous exécutez apigee-access:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

La valeur renvoyée par getMode() vous indique si l'application Node.js est déployée sur Apigee Edge ou s'exécute en mode autonome. La méthode renvoie l'un de ces deux résultats de chaîne:

apigee : l'application Node.js s'exécute sur Apigee Edge et toutes les fonctionnalités sont compatibles.
standalone : l'application Node.js s'exécute en dehors de l'environnement Apigee Edge. La fonctionnalité par défaut décrite en haut du document prend effet.

Exécuter en mode déployé

Lorsqu'elles sont déployées sur Edge, les variables définies par des règles sont visibles par apigee-access, et les variables ajoutées ou modifiées par les méthodes de ce module sont visibles pour les stratégies suivantes dans le flux proxy.

Vous trouverez le lien vers les variables compatibles dans la documentation de référence sur les variables. Ces variables, ainsi que celles que vous créez avec vos propres noms, sont visibles par apigee-access. Notez que certaines variables sont en lecture seule. Elles sont indiquées dans la documentation de référence sur les variables.

Exécution en mode local

En "mode local", vous exécutez votre code Node.js en dehors du contexte d'Apigee Edge. Dans ce mode, la plupart des variables de flux prédéfinies ne sont pas accessibles dans votre code Node.js. Ce tableau présente le petit sous-ensemble de variables de flux disponibles. Ces variables sont prises en charge ici afin de faciliter le développement et le test locaux d'applications Node.js pour Apigee Edge.

Variable	Lecture seule	Type	Remarques
`client.received.start.time`	Oui	Chaîne	Heure à laquelle la demande a été reçue.
`client.received.end.time`	Oui	Chaîne	Heure à laquelle la demande a été reçue.
`client.received.start.timestamp`	Oui	Entier	Heure à laquelle la demande a été reçue.
`client.received.end.timestamp`	Oui	Entier	Heure à laquelle la demande a été reçue.

Là encore, la plate-forme Apigee Edge prend en charge un ensemble beaucoup plus important de variables prédéfinies. Reportez-vous à la documentation de référence sur les variables d'Apigee Edge pour obtenir la liste complète.