Altova MapForce 2025 Enterprise Edition

Ce chapitre décrit la définition manuelle d’un appel de service HTTP API Pour être capable de configurer un appel vers un HTTP API manuellement, ouvrez le dialogue Paramètres d’appel de service web et sélectionnez Manuel dans la section Définition de service Les paramètres que vous pouvez configurer sont décrits dans les sous-sections ci-dessous.

 

La capture d’écran ci-dessous illustre la définition manuelle d’un appel échantillon vers HTTP API.

mf_ws_01_zoom70

En option, si vous avez le fichier WADL d’un service Web, vous pouvez importer les paramètres de service Web en cliquant Importer depuis WADL (voir Importer depuis WADL). Aussi, si vous voulez extraire les paramètres de service Web depuis une URL, cliquez sur le bouton Importer depuis URL (voir Importer depuis l’URL).

 

Méthode de requête

Ce paramètre vous permet de définir la méthode HTTP (par ex., GET, POST, PUT, etc.) que MapForce devrait utiliser pour appeler le service Web. Vous pouvez sélectionner une valeur depuis la liste existante ou saisir le nom de la méthode de requête. Les noms de méthode HTTP sont sensibles à la casse.

 

Paramètres de connexion

URL

La case de texte URL spécifie l’adresse de votre (URL) service Web.

 

Services Web RESTful

En option, vous pouvez transformer des parties spécifiques de l'URL dans des paramètres et les fournir depuis le mappage principal. Pour des URL définies de cette manière, veuillez noter les points suivants :

 

Si vous appelez un service Web avec des paramètres style modèle ou matrice, englobez les paramètres à l’intérieur des accolades, par exemple : http://example.org/api/products/{id}. Ensuite, définisez les paramètres de chaque paramètre dans la table des Paramètres. Au moment de l'exécution, MapForce remplace les espaces réservés dans des accolades avec les valeurs de paramètre réelles et produit l'URL finale.

Si vous appelez un service Web avec des paramètres d'URL requête (ex., http://example.org/api/products?sort=asc&category=1&page=1), ne saisissez pas la partie de requête dans le champ de saisie URL. À la place, définissez les paramètres uniquement dans la table des Paramètres et assurez-vous de les désigner en tant que paramètres de style requête.

 

URL dynamique (fournie par le mappage)

Si vous souhaitez fournir l'URL du service Web provenant du mappage principal, sélectionnez la case à cocher URL dynamique (fournie par le mappage). Ceci crée un connecteur d’entrée supplémentaire dans le composant de service du mappage, auquel vous pouvez connecter quelque entrée qui fournit l’URL du service Web.

 

Note : Lorsque la case à cocher URL dynamique (fournie par le mappage) est sélectionnée, la case de texte URL sera désactivée, et vous devrez fournir l’URL depuis le mappage principal. Pour les services Web REST-style, ceci signifie aussi de définir uniquement des paramètres Header-style dans la table Paramètres.

 

Avec des URL entièrement ou partiellement dynamiques, vous pouvez ajuster l’URL de manière flexible selon vos besoins. Par exemple, vous pouvez exécuter le mappage avec une URL spécifique pendant le développement et utiliser une URL différente en production, sans modifier le mappage. Une URL comme https://{host}/some/path/to/service le permettrait, en partant du principe que le nom d'hôte est la seule différence entre la production et le test des URL, et vous pouvez le fournir en tant que paramètre dans le mappage. Noter que les URL partiellement dynamiques renforcent une validation plus stricte, puisque seules les parties d'URL désignées sont remplacées avec des valeurs mappables ou de marche runtime.

 

Avec des URL entièrement dynamiques, toute l'URL est mappable et vous en détenez le contrôle complet ; la seule exigence est que l'URL doit commencer avec http:// ou https:// et il faut une URI valide. Les URL dynamiques permettent également de fournir l'URL retournée depuis un appel de service Web en tant qu'entrée dans un autre composant qui peut appeler le même service Web (ou un autre).

 

Délai d’expiration

Le paramètre Timeout définit l’intervalle de temps après lequel l’appel de service Web sera en mode ‘délai d’expiration’ s’il n’existe pas de réponse depuis le serveur. Sélectionnez Infinite si l’appel doit attendre une réponse pour un moment indéfini.

 

 

Notes relatives aux paramètres dans l’URL

En option, vous pouvez transformer des parties spécifiques de l'URL dans des paramètres et les fournir des valeurs à ces paramètres depuis le mappage principal. Pour des URL définies de cette manière, veuillez noter les points suivants :

 

Si vous appelez un service Web avec des paramètres style modèle ou matrice, englobez les paramètres à l’intérieur des accolades, par exemple : http://example.org/api/products/{id}. Ensuite, définissez les paramètres de chaque paramètre dans la table Paramètres. Au moment de l'exécution, MapForce remplace les espaces réservés dans des accolades avec les valeurs de paramètre réelles et produit l'URL finale.

Si vous appelez un service Web avec des paramètres d'URL requête (ex., http://example.org/api/products?sort=asc&category=1&page=1), ne saisissez pas la partie de requête dans le champ de saisie URL. À la place, définissez les paramètres uniquement dans la table des Paramètres et assurez-vous de les désigner en tant que paramètres de style requête.

 

Structures

Cette section du dialogue vous permet de sélectionner les structures de requête et de réponse de votre service Web appeler. Lorsque vous appelez les services Web qui s’attendent à du contenu dans la partie du corps du message de requête ou du contenu de renvoi dans la partie du contenu dans le message de réponse, vous pouvez définir les structures de requête et de réponse comme suit :

 

Pas de structure

XML

JSON

Protocol Buffers

 

Note :Dans les appels de service Web créés avec MapForce, vous pouvez utiliser un JSON standard en tant que structure de requête ou de réponse ; les structures JSON Lines ou JSON5 ne sont pas prises en charge.

 

La structure sélectionnée détermine les items mappables qui apparaissent avant le mappage comme enfants de l’item Body mf_ic_body.

 

Pour les détails sur les structures de requête et de réponse, voir Structures Requête/Réponse.

 

Paramètres

Si vous appelez un service Web avec des paramètres URL, vous devez définir les paramètres dans la section Paramètres de la boîte de dialogue Paramètres d’Appel de Service Web (capture d’écran ci-dessous). Cette boîte de dialogue vous permet également de configurer la requête de service Web avec des en-têtes personnalisées.

 

En alternative à la définition manuelle, vous pouvez aussi remplir les paramètres de service Web automatiquement, en les important depuis une URL existante ou depuis un fichier WADL.

mf_ws_03

Pour plus de détails sur les paramètres, voir Paramètres.

 

Paramètres de sécurité HTTP

Vous allez éventuellement devoir configurer les paramètres de sécurité HTTP dans les scénarios suivants :

 

Le service Web est appelé via HTTPS et requiert un certificat client.

Le serveur utilise un certificat incorrect, et vous aimeriez autoriser un décalage entre le certificat et la requête.

Le service Web requiert l’authentification HTTP de base ou l’autorisation OAuth 2.0.

 

Pour plus d’information, voir Paramètres de sécurité HTTP.

 

Enregistrer tous les chemins de fichier relatifs au fichier MFD

Lorsque cette option est activée, MapForce enregistre les chemins de fichier affichés dans le dialogue Paramètres de composant relatif à l’emplacement du fichier de MapForce Design (.mfd). Voir aussi Utiliser des chemins relatifs et absolus.

 

© 2018-2024 Altova GmbH