Application de workflow RESTAPICLIENT
Aperçu
L'application de workflow RESTAPICLIENT vous permet d'appeler des points de terminaison de l'API REST pour échanger des informations avec d'autres applications via des requêtes HTTP. Elle peut également être utilisée pour créer des intégrations avec des applications extensibles (telles que les services Azure et Slack).
RESTAPICLIENT vous permet également d'appeler un point de terminaison de l'API REST à l'aide de charges utiles application/json
ou application/x-www-form-urlencoded
. RESTAPICLIENT recevra et traitera ensuite la réponse de l'API externe en mappant le contenu de la réponse avec les paramètres OUT définis.
Mode de fonctionnement
L'application RESTAPICLIENT requiert le paramètre
APP_URL
, qui correspond au point de terminaison de l'API REST.Le type de contenu du charge utile de demande par défaut (
APP_REQUEST_CONTENT_TYPE
) estapplication/json
. Le type de contenuapplication/x-www-form-urlencoded
est également supporté.La méthode de requête HTTP de demande par défaut (
APP_METHOD
) est GET. D'autres méthodes de requête (POST
,PUT
,DELETE
, etc...) sont également supportées.En cas d'erreur, lorsque le paramètre IN
APP_RESPONSE_IGNORE_ERROR
est défini et que sa valeur estY
, l'erreur est ignorée et les paramètres OUT définis (APP_RESPONSE_STATUS
ouAPP_RESPONSE_CONTENT
) sont mappés. Sinon, une exception sera levée.Les paramètres de l’application étant sensibles à la casse, ils doivent utiliser la notation acceptée par l’API.
Le délai d'expiration de la demande par défaut est de 3 000 millisecondes; cette valeur par défaut peut être modifiée en définissant la valeur du paramètre
RestApiClientRequestTimeout
dans le fichierweb.config
. Le délai d'expiration de la demande peut également être défini dans le paramètre INAPP_TIMEOUT
; le délai d'expiration maximum est de 60 000 millisecondes (1 heure). ✏️ Note : Cette valeur de délai d'expiration doit être inférieure à la valeur de délai d'expiration de la demande IIS.Les en-têtes de requête HTTP peuvent être définis avec les paramètres
APP_HEADER_xxx
, oùxxx
est le nom du champ d'en-tête. Pour plus d'informations, voir la section Paramètres d'en-tête.La charge utile de la demande peut être définie dans les paramètres IN
APP_REQUEST_CONTENT_FILE
ouAPP_REQUEST_CONTENT
. Lorsque les deux paramètres sont définis, le paramètreAPP_REQUEST_CONTENT_FILE
est prioritaire. Pour plus d'informations sur ces paramètres, voir la section Charge utile de demande.La réponse de l'API REST peut être mappée sur les paramètres OUT
APP_RESPONSE_CONTENT_FILE
ouAPP_RESPONSE_CONTENT
. Les deux paramètres peuvent être définis en même temps. Pour plus d'informations sur ces paramètres, voir la section Charge utile de réponse.Outre les paramètres facultatifs listés ci-dessous, vous pouvez également ajouter des paramètres supplémentaires IN et OUT personnalisés pour envoyer et recevoir des données personnalisées définies par l'utilisateur vers et depuis l'API externe. Pour plus d'informations et des exemples sur ces paramètres IN et OUT personnalisés, voir les sections Charge utile de demande et Charge utile de réponse.
L'application supporte le langage de requête JSONPath (voir https://github.com/json-path/JsonPath), qui permet d'extraire des données spécifiques à partir d'une réponse JSON (similaire aux expressions XPath en XML). Pour plus d'informations sur l'utilisation de cette application avec des exemples, voir la section Charge utile de réponse.
Des logs d'application sont disponibles. Ceux-ci peuvent être spécifiés en définissant la valeur du paramètre
RestApiClientLogLevel
dans le fichierweb.config
sur0
pour désactiver la journalisation,1
pour les logs simples ou2
pour les logs de débogage; la valeur par défaut est0
.La longueur de réponse maximale par défaut est de 4194304 caractères (4 Mo); cette valeur par défaut peut être modifiée en définissant la valeur du paramètre
RestApiClientMaxResponseLength
dans le fichierweb.config
.La suppression automatique des fichiers temporaires peut être désactivée en définissant la valeur du paramètre
RestApiClientEnableFilesCleanUp
surN
dans le fichierweb.config
; la valeur par défaut estY
.
Paramètre obligatoire
Paramètre | Type | Direction | Description |
| Text | IN | URL de l'API externe |
Paramètres facultatifs
Général
Paramètre | Type | Direction | Description |
| Numeric | IN | Intervalle de temps maximum entre l'envoi de la demande et la réception de la réponse La valeur par défaut est 3 000 millisecondes et le maximum est 60 000 millisecondes. La valeur par défaut peut être modifiée en définissant la valeur du paramètre ✏️ Note : Cette valeur de délai d'expiration doit être inférieure à la valeur de délai d'expiration de la demande IIS. |
| Text | IN | Méthode d'API La valeur par défaut est |
| Text | IN | Type de contenu de requête supporté par l'API externe L’application supporte |
| Text | IN | Lorsque défini sur |
Paramètres APP_URL
facultatifs
APP_URL
facultatifsParamètre | Type | Direction | Description |
| Text | IN | Paramètre facultatif d'URL de l'API où |
📌 Exemple
Paramètre | Type | Direction | Valeur |
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
Les paramètres définis ci-dessus généreront l'URL suivante dans APP_URL
:
Paramètres d'en-tête
Paramètre | Type | Direction | Description |
| Text | IN | Paramètres d'en-tête de l'API externe où |
📌 Exemple
Paramètre | Type | Direction | Valeur |
| Text | IN |
|
| Text | IN |
|
Les paramètres définis ci-dessus généreront deux en-têtes dans la charge utile de la demande :
Paramètres d'autorisation
L'application supporte également certains paramètres d'en-tête d'autorisation prédéfinis afin d'éviter d'ajouter ces paramètres d'en-tête HTTP avec le nom de paramètre APP_HEADER_xxx
.
Paramètre | Type | Direction | Description |
| Text | IN | Nom d'utilisateur de base de l'autorisation API |
| Text | IN | Mot de passe de base de l'autorisation API API authorization Basic password; doit être utilisé avec le paramètre |
| Text | IN | Jeton du porteur de l'autorisation API |
| Text | IN | Jeton SAS Azure de l'autorisation API |
Un seul en-tête d'autorisation peut être défini, sinon une exception est levée.
APP_AUTH_BEARER_TOKEN
équivaut à définir le paramètre d'en-têteAPP_HEADER_Authorization
.
Charge utile de demande
Il existe deux manières différentes de préparer la charge utile de demande. La première consiste à accéder à la totalité de la charge de demande (voir Définir la charge utile de la demande entière via un paramètre ci-dessous); la seconde consiste à créer le JSON ou l'URL codée via les paramètres IN (voir les sections Charge utile de demande encodée en URL et la Charge utile de demande JSON ci-dessous.
Définir la charge utile de demande entière via un paramètre
Les paramètres suivants peuvent être utilisés lorsque vous avez accès à l'ensemble de la charge utile de demande ou que le type de contenu de la demande n'est pas application/json
ni application/x-www-form-urlencoded
. Vous pouvez définir la charge de cette demande dans une donnée de type File ou Text ou directement dans la valeur de texte.
Paramètre | Type | Direction | Description |
| File | IN | Demander une charge utile dans un fichier |
| Text | IN | Charge utile de la demande |
APP_REQUEST_CONTENT_FILE
a la priorité surAPP_REQUEST_CONTENT
.APP_REQUEST_CONTENT
a la priorité sur les paramètres IN utilisés pour créer une charge utile JSON ou encodée en URL.
Charge utile de demande encodée en URL
Les exemples suivants montrent comment créer une charge utile de demande avec application/x-www-form-urlencoded
comme type de contenu.
Charge utile de demande en URL standard
Les paramètres suivants sont utilisés pour créer une charge utile de demande encodée en URL standard :
Paramètre | Type | Direction | Description |
| Text | IN |
|
| Text | IN |
|
Les paramètres définis ci-dessus généreront la charge utile de demande suivante :
Charge utile de demande JSON encodée dans un nom de clé
Les paramètres suivants permettent de générer une charge JSON encodée dans un nom de clé :
Paramètre | Type | Direction | Description |
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
Les paramètres définis ci-dessus généreront la charge utile de demande suivante :
Le paramètre APP_REQUEST_CONTENT_PAYLOAD_NAME
est seulement supporté avec le type de contenu de demande application/x-www-form-urlencoded
.
Charge utile de demande JSON
Les exemples suivants montrent comment créer une charge utile de demande avec application/json
comme type de contenu.
Charge utile de demande JSON standard
Les paramètres suivants sont utilisés pour créer une charge utile de demande JSON simple :
Paramètre | Type | Direction | Valeur |
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
Les paramètres définis ci-dessus généreront la charge utile de demande suivante :
Si vous souhaitez convertir ce JSON en tableau, vous devez définir la valeur du paramètre APP_REQUEST_CONTENT_IS_ARRAY
sur Y
.
Paramètre | Type | Direction | Description |
| Text | IN | Lorsque ce paramètre est défini sur Uniquement supporté lors de la construction d'une charge utile de demande JSON avec des paramètres IN. |
Le paramètre APP_REQUEST_CONTENT_IS_ARRAY
défini sur Y
générera la charge utile de demande suivante :
Pour savoir comment créer un JSON plus complexe, voir les sections Définition d'un tableau JSON dans une propriété JSON et Définition d'un objet ou d'un tableau JSON dans une propriété JSON avec le paramètre de suffixe __JSON
ci-dessous.
Définition d'un tableau JSON dans une propriété JSON
Pour définir un tableau dans une propriété JSON, vous devez définir le chemin de la propriété (par exemple, person.spokenlanguages
) suivi du suffixe __X
, où X
est le numéro d'index du tableau.
Les paramètres suivants permettent de définir un tableau JSON dans une propriété JSON :
Paramètre | Type | Direction | Valeur |
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
Les paramètres définis ci-dessus généreront la charge utile de demande suivante :
Si vous souhaitez définir un tableau JSON d'objets JSON (p.ex. "spokenlanguages": [{"spokenlanguage":"french"}, {"spokenlanguage":"english"}]
) dans une propriété JSON, voir la section suivante.
Les paramètres du tableau seront ordonnés en fonction de leur numéro d'index.
Les numéros index n'ont pas de limite (p.ex.
person.spokenlanguages__9999
).Une séquence d'index correcte n'est pas obligatoire (p.ex.
person.spokenlanguages__90
,person.spokenlanguages__30
). La valeur du paramètre __30 sera le premier paramètre de tableau et__90
sera le deuxième.Une exception sera levée si plusieurs propriétés JSON sont spécifiées dans les paramètres IN (p.ex.
person.spokenlanguages
etperson.spokenlanguages__0
).Le suffixe
__X
utilise deux caractères de soulignement.La valeur du paramètre ne peut être qu'une valeur de texte.
Définition d'un objet ou d'un tableau JSON dans une propriété JSON avec le paramètre de suffixe __JSON
Pour définir un objet / un tableau JSON dans une propriété JSON, vous devez définir le chemin de la propriété (p.ex. person.children
) suivi du suffixe __JSON
avec l'objet ou le tableau JSON comme valeur de paramètre.
Les paramètres suivants permettent de définir un objet ou un tableau JSON dans une propriété JSON:
Paramètre | Type | Direction | Valeur |
| Text | IN |
|
Les paramètres définis ci-dessus généreront la charge utile de demande suivante :
Une exception sera levée si plusieurs propriétés JSON sont spécifiées dans les paramètres IN (p.ex.
person.children
etperson.children__JSON
).Le suffixe
__JSON
utilise deux caractères de soulignement.
Charge utile de réponse
L'application supporte le mappage des paramètres OUT avec la réponse HTTP :
Paramètre | Type | Direction | Description |
| Text/Numeric | OUT | Code statut de la réponse |
| Text | OUT | Type de contenu de la réponse |
| File | OUT | Charge utile de la réponse ou message d'erreur dans un fichier |
| Text | OUT | Charge utile de la réponse ou message d'erreur |
| Text | OUT | Renvoie Seulement supporté pour les réponses de type de contenu |
Mappage d'une charge utile de réponse JSON avec des paramètres OUT
L'application supporte également des paramètres OUT personnalisés supplémentaires pour mapper la charge utile d'une réponse JSON simple.
📌 Exemple
Charge utile de réponse JSON :
Les paramètres suivants permettront de mapper la charge utile de la réponse dans différentes données de processus :
Paramètre | Type | Direction | Récupérer la valeur dans une donnée |
| Text | OUT |
|
| Text | OUT |
|
| Text | OUT |
|
| Text | OUT |
|
Pour mapper des JSON complexes, voir la section suivante.
Mappage d'une charge utile de réponse JSON avec des paramètres OUT à l'aide du langage de requête JSONPath
L'application supporte le langage de requête JSONPath (similaire aux expressions XPath en XML). Ce langage vous permet d'extraire des données spécifiques d'un fichier JSON. Pour plus de détails sur la syntaxe JSONPath, voir https://github.com/json-path/JsonPath.
📌 Exemple
Charge utile de réponse JSON :
Par exemple, nous voulons ici obtenir les noms des petits-fils de Charles âgés de plus de sept ans, et nous voulons également que ces noms soient séparés par un |
(en utilisant le paramètre IN APP_JSONPATH_DELIMITER
). Pour obtenir cette information, les paramètres suivants doivent être définis :
Paramètre | Type | Direction | Valeur IN | OUT Value |
| Text | IN |
| - |
| Text | INOUT |
|
|
Dans le nom du paramètre
PARAM1__JSONPATH
, le nom dePARAM1
n'est pas pertinent, mais il doit être suivi du suffixe__JSONPATH
(deux traits de soulignement sont utilisés dans le suffixe).La valeur par défaut de
APP_JSONPATH_DELIMITER
est une virgule (,
) lorsque ce paramètre n'est pas défini.
Exemple d'utilisation avec l'API Azure REST pour obtenir un jeton d'accès OAuth 2.0 et créer une rubrique Event Grid
Cet exemple montre comment obtenir un jeton d'accès et l'utiliser pour créer une rubrique Event Grid. Cela peut être fait en créant un processus avec deux actions ayant RESTAPICLIENT comme application. Le workflow ci-dessous illustre cet exemple :
![](https://docs.advantys.com/~gitbook/image?url=https%3A%2F%2Fuser-images.githubusercontent.com%2F22150605%2F56391674-54de8480-61fd-11e9-8b6b-5645563e0d6d.png&width=768&dpr=4&quality=100&sign=6e56a8ce&sv=1)
Les sections suivantes décrivent les paramètres à déclarer pour chaque action.
Action GET_TOKEN
: Obtention d'un jeton d'accès OAuth 2.0
GET_TOKEN
: Obtention d'un jeton d'accès OAuth 2.0Les paramètres suivants sont nécessaires pour obtenir un jeton d'accès afin d'utiliser l'API de gestion Azure Resource. Ce jeton sera stocké dans le paramètre OUT access_token
et sera utilisé lors de la création d'une rubrique Event Grid dans la section suivante.
Paramètre | Type | Direction | Valeur |
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | OUT |
|
Les paramètres définis ci-dessus généreront la charge utile de demande suivante :
Voici la réponse de l'API Azure :
Le paramètre OUT access_token
est mappé avec la propriété JSON access_token
.
Pour plus d'informations sur l'obtention d'un jeton d'accès pour utiliser l'API de ressource Azure, voir https://docs.microsoft.com/fr-fr/azure/active-directory/develop/v1-oauth2-client-creds-grant-flow.
Action CREATE_TOPIC
: création d'une rubrique Event Grid
CREATE_TOPIC
: création d'une rubrique Event GridLes paramètres suivants sont nécessaires pour créer une rubrique Event Grid à l'aide de l'API de gestion des ressources Azure.
Paramètre | Type | Direction | Valeur |
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
| Text | IN |
|
Les paramètres définis ci-dessus généreront la charge utile de demande suivante :
Voici la réponse de l'API Azure:
Pour plus d'informations sur la création d'une rubrique Event Grid et sur l'API Azure REST, voir https://docs.microsoft.com/fr-fr/rest/api/eventgrid/topics/createorupdate.
Activation de SSL / TLS
En cas d'erreur Impossible de créer le canal sécurisé SSL / TLS
, le chiffrement renforcé doit être activé en exécutant le code suivant dans PowerShell :
Redémarrez votre serveur IIS après avoir exécuté les commandes.
Dernière mise à jour