Variables contextuelles d'API Connect

Liste des variables contextuelles d'API Connect que vous pouvez référencer lors de la définition des valeurs de paramètre par défaut dans une opération d'assemblage ou en utilisant la fonction getContext() lors de la définition d'une stratégie.

Deux tableaux sont présentés avec les rubriques ci-après.

Variables contextuelles d'API Connect.
Variables contextuelles d'OAuth.

Pour plus d'informations sur l'implémentation d'un composant d'assemblage, voir Inclusion de composants dans un assemblage et pour plus d'informations sur la manière de référencer des variables contextuelles dans IBM® API Connect, voir Références de variable dans API Connect.

Pour plus d'informations sur la création d'une stratégie définie par l'utilisateur, voir Création de stratégies.

Variables contextuelles

Remarque : Certaines variables contextuelles peuvent être utilisées avec les passerelles DataPower Gateway et Micro Gateway, mais d'autres sont restreintes à une passerelle particulière ou renvoient des résultats dans un format différent suivant la passerelle. Les restrictions ou les différences sont indiquées par les icônes suivantes :

Indique que la variable contextuelle n'est disponible que sur la passerelle DataPower Gateway.
Indique que la variable contextuelle n'est disponible que sur la passerelle Micro Gateway.

Remarque : pour les variables de plan (telles que plan.name ou plan.version), les informations de plan ne sont disponibles que si l'opération demandée requiert une identification et que le client réussit la vérification d'authentification.

Tableau 1. Variables contextuelles d'API Connect
Nom	Description	Droits
`api.name`	Titre de l'API.	Lecture-Ecriture
`api.document`	Document OpenAPI (Swagger 2.0).	Lecture-Ecriture
`api.root`	Chemin de base de l'API. Utilisez `api.document.basepath` comme chemin de base de l'API.	Lecture-Ecriture
`api.version`	Chaîne de version de l'API.	Lecture-Ecriture
`api.endpoint.address`	Adresse du noeud final de la passerelle d'API.	Lecture-Ecriture
`api.endpoint.hostname`	Nom d'hôte du noeud final de la passerelle API, comme requis par l'application.	Lecture-Ecriture
`api.operation.id`	ID de l'opération.	Lecture-Ecriture
`api.operation.path`	Chemin de l'opération.	Lecture-Ecriture
`api.org.id`	ID organisation du fournisseur d'API.	Lecture-Ecriture
`api.org.name`	Nom abrégé de l'organisation du fournisseur d'API.	Lecture-Ecriture
`api.type`	Type d'API ; REST ou SOAP.	Lecture-Ecriture
`api.properties.nom_propriété`	Nom d'une propriété d'API personnalisée. Les valeurs des propriétés sont spécifiques au catalogue. Remarque : Vous disposez de droits d'accès en écriture à une propriété personnalisée uniquement à partir de l'interface utilisateur et non de GatewayScript.	Lecture-Ecriture
`client.app.name`	Nom de l'application qui est identifiée comme ayant émis la demande.	Lecture-Ecriture
`client.app.id`	ID client ou clé d'application reçus dans la demande.	Lecture-Ecriture
`client.app.secret`	Valeur confidentielle du client reçue dans la demande.	Lecture-Ecriture
`client.app.type`	Statut de l'application client appelante. Les valeurs possibles sont les suivantes : Développement Production (valeur par défaut) Pour plus d'informations, voir Gestion du cycle de vie des applications.	Lecture-Ecriture
`client.org.id`	Clé d'identification unique de l'organisation propriétaire de cette application.	Lecture-Ecriture
`client.org.name`	Nom de l'organisation propriétaire de cette application.	Lecture-Ecriture
`env.path`	Segment de chemin qui représente ce catalogue.	Lecture-Ecriture
`message.body`	Contenu du message de demande ou de réponse. Remarque : la variable contextuelle `message.body` n'est pas prise en charge avec la fonction `getContext()`. Utilisez la fonction `getvariable()` à la place.	Lecture-Ecriture
`message.headers.nom`	Valeur de l'en-tête de demande HTTP nommé. Remarque : `nom` doit être entré en minuscules.	Lecture-Ecriture
`message.status.code`	Code de statut HTTP de la réponse.	Lecture-Ecriture
`message.status.reason`	Phrase du motif HTTP de la réponse.	Lecture-Ecriture
`plan.name`	Nom du plan.	Lecture-Ecriture
`plan.id`	Identificateur unique du plan.	Lecture-Ecriture
`plan.version`	Numéro de version du plan.	Lecture-Ecriture
`plan.rate-limit`	Limite de débit (nombre d'appels d'API par intervalle de temps) du plan.	Lecture-Ecriture
`request.authorization`	L'en-tête HTTP `authorization` analysé.	Lecture seule
`request.body`	Contenu de la demande entrante.	Lecture seule
`request.content-type`	Valeur de type de contenu normalisée.	Lecture seule
`request.date`	Objet de date qui représente à peu près le moment où la demande a été reçue par la passerelle.	Lecture seule
`request.headers.nom_en-tête`	Valeur de l'en-tête de demande HTTP nommé. Remarque : Le `nom-en-tête` doit être entré en minuscules.	Lecture seule
`request.parameters`	Vous pouvez obtenir vos paramètres entrants à partir des paramètres de chemin et de requête.	Lecture seule
`request.path`	Section de chemin de `request.uri` qui commence par le chemin de base de l'API, y compris le caractère '/' par lequel débute le chemin de base.	Lecture seule
`request.querystring`	Chaîne de requête de la demande non précédée du point d'interrogation.	Lecture seule
`request.search`	Chaîne de requête de la demande précédée du point d'interrogation.	Lecture seule
`request.uri`	L'URI complet de la demande HTTP à partir de l'application.	Lecture seule
`request.verb`	Instruction HTTP de cette demande.	Lecture seule
`system.datetime`	Renvoie une chaîne qui représente la date et l'heure actuelles dans le fuseau horaire du système.	Lecture seule
`system.time`	Renvoie une chaîne qui représente l'heure en cours dans le fuseau horaire du système. Renvoie l'heure actuelle dans le fuseau horaire du système, dans un objet JSON.	Lecture seule
`system.time.hour`	Renvoie un nombre de 0 à 23 inclus, représentant la partie heure de l'heure actuelle dans le fuseau horaire du système.	Lecture seule
`system.time.minute`	Renvoie un nombre de 0 à 59 inclus, représentant la partie minutes de l'heure actuelle dans le fuseau horaire du système.	Lecture seule
`system.time.seconds`	Renvoie un nombre de 0 à 59 inclus, représentant la partie secondes de l'heure actuelle dans le fuseau horaire du système.	Lecture seule
`system.date`	Renvoie une chaîne qui représente la date actuelle dans le fuseau horaire du système. Renvoie un objet JSON qui représente la date actuelle dans le fuseau horaire du système.	Lecture seule
`system.date.day-of-week`	Renvoie un nombre de 1 à 7 inclus (lundi au dimanche) représentant le jour de la semaine dans le fuseau horaire du système.	Lecture seule
`system.date.day-of-month`	Renvoie un nombre de 1 à 31 inclus représentant le jour de la semaine dans le fuseau horaire du système.	Lecture seule
`system.date.month`	Renvoie un nombre de 1 à 12 représentant le mois dans le fuseau horaire du système.	Lecture seule
`system.date.year`	Renvoie un nombre à quatre chiffres qui représente l'année dans le fuseau horaire du système.	Lecture seule
`system.timezone`	Renvoie un identificateur ISO 8601 du fuseau horaire du système, qui peut inclure un signe, une heure à deux chiffres et des minutes. Par exemple, `-04:00`.	Lecture seule

Tableau 2. Variables contextuelles d'OAuth. Les variables contextuelles d'OAuth ne sont disponibles que si IBM API Connect sert de serveurs de ressources OAuth.
Nom d'API	Description	Droits
`oauth.access-token`	Si la demande est authentifiée avec OAuth, cette variable contient la chaîne du jeton d'accès.	Lecture-Ecriture
`oauth.miscinfo`	Cette variable contient des informations qui sont explicitement inclues dans les en-têtes suivants : URL d'authentification URL de métadonnées	Lecture-Ecriture
`oauth.not-after`	Si la demande est authentifiée avec OAuth, cette variable contient la date d'expiration du jeton.	Lecture-Ecriture
`oauth.not-before`	Si la demande est authentifiée avec OAuth, cette variable contient la date d'émission du jeton.	Lecture-Ecriture
`oauth.resource-owner`	Si la demande est authentifiée avec OAuth, cette variable contient le nom du propriétaire de la ressource.	Lecture-Ecriture
`oauth.scope`	Si la demande est authentifiée avec OAuth, cette variable contient la portée de ce jeton d'accès.	Lecture-Ecriture
Variables contextuelles disponibles pour l'introspection.		Lecture-Ecriture
`oauth.introspect.active`	Toujours disponible. Valeur booléenne.	Lecture-Ecriture
`oauth.introspect.response`	Toujours disponible. Affiche le contenu complet de la réponse actuelle. Exemple de valeur de contenu : `{“active”:true, “client_id”, “xxx-xxx”, “token_type”, “bearer”, “scope”:“neon”}`	Lecture-Ecriture
D'autres variables du tiers peuvent être disponibles, sous la forme suivante : `oauth.introspect.<variable>`	En décodant l'exemple ci-dessus, les variables ci-après sont mises à disposition pour la suite du traitement. `oauth.introspect.client_id: xxx-xxx oauth.introspect.token_type: bearer oauth.introspect.scope: neon`	Lecture-Ecriture

Dernière mise à jour : Lundi 06 novembre 2017