Ajout d'un service Web externe

Pour les services Web REST :

URL

Si vous n'avez pas fourni de WADL à l'étape Descripteur, saisissez un exemple d'URL de requête contenant les paramètres de chemin d'accès (le cas échéant) et les paramètres de requête que vous souhaitez inclure dans la requête. Par exemple :

http://example.com/rest/customers/{state}?age=31

Ici, il existe un paramètre de chemin d'accès, {state}, et un paramètre de requête, age.

Si vous avez fourni un WADL à l'étape Descripteur, le champ URL affiche le point de terminaison basé sur le WADL fourni. Vous ne pouvez pas modifier le point de terminaison.

Resource

Ce paramètre n'est visible que si vous avez fourni une WADL à l'étape Descripteur. Sélectionnez la ressource de service Web que vous souhaitez exposer sur Spectrum™ Technology Platform.

Remarque : Si vous souhaitez exposer plus d'une ressource, vous devez définir un service Web externe distinct pour chaque ressource.

Méthode

Sélectionnez la méthode HTTP dans la requête auprès du service Web externe.

Si vous avez fourni une WADL à l'étape Descripteur, seules les méthodes HTTP prises en charge par le service Web externe sont répertoriées.

Paramètres de chemin d'accès

La section Paramètres de chemin d'accès répertorie les paramètres qui font partie du chemin d'accès à l'URL, si le service Web externe utilise des paramètres de chemin d'accès. Par exemple, cette URL contient le paramètre de chemin d'accès {state} :

http://example.com/rest/customers/{state}?age=31

Si vous avez fourni un WADL à l'étape Descripteur, les paramètres de chemin d'accès du service Web sont répertoriés. Si vous n'avez pas fourni de WADL à l'étape Descripteur, la liste des paramètres de chemin d'accès est générée à partir de l'exemple d'URL de requête que vous avez fourni dans le champ URL. Pour ajouter ou supprimer un paramètre de chemin d'accès, ajoutez-le à l'URL ou supprimez-le de l'URL. Tout élément de l'URL délimitée par des accolades est interprété comme un paramètre de chemin d'accès.

Paramètres de requête

La section Paramètres de requête répertorie les paramètres qui apparaissent après le « ? » dans l'URL de requête. Par exemple, cette URL contient le paramètre de requête age :

http://example.com/rest/customers/{state}?age=31

Si vous avez fourni un WADL à l'étape Descripteur, les paramètres de requête du service Web sont répertoriés. Si vous n'avez pas fourni de WADL à l'étape Descripteur, la liste des paramètres de requête est générée à partir de l'exemple d'URL de requête que vous avez fourni dans le champ URL. Pour ajouter ou supprimer un paramètre de requête, ajoutez-le à l'URL ou supprimez-le de l'URL.

Tableau 1. Paramètres de chemin d'accès et paramètres de requête REST

Paramètre	Description
Exposer	Cochez la case de cette colonne pour rendre le paramètre disponible dans le stage Spectrum™ Technology Platform.
Requête	Cette colonne affiche le nom de paramètre utilisé dans la requête auprès du service Web externe.
Input	Cette colonne répertorie les noms de champ d'entrée tels qu'ils apparaîtront dans un flux. Vous pouvez laisser les noms identiques à ceux utilisés par le service Web tiers ou vous pouvez les modifier en survolant le nom et en cliquant sur le bouton Modifier .
Valeur par défaut	Cochez la case de cette colonne si vous souhaitez spécifier une valeur par défaut pour le champ. Saisissez la valeur par défaut dans le champ qui apparaît après avoir coché la case. Si vous souhaitez fournir une valeur par défaut qui ne peut pas être remplacée d'un flux, cochez la case de la colonne Valeur par défaut et décochez la case correspondante de la colonne Requête. Cela masque le champ des flux tout en fournissant la valeur par défaut dans la requête auprès du service Web externe. Cela peut être utile si vous disposez d'une clé d'accès que vous devez fournir dans chaque requête. Par exemple :

Pour les services Web SOAP :

URL

Ce champ affiche le point de terminaison en fonction du WSDL que vous avez fourni à l'étape Descripteur. Vous ne pouvez pas modifier ce champ.

Opération

Sélectionnez l'opération de service Web que vous souhaitez effectuer.

Remarque : Si vous souhaitez exposer plus d'une opération, vous devez définir un service Web externe distinct pour chaque opération.

Requête

Dans cette colonne, sélectionnez les champs et les options que vous souhaitez rendre disponible via Spectrum™ Technology Platform.

Input

Cette colonne répertorie les noms de champ d'entrée tels qu'ils apparaîtront dans un flux. Vous pouvez laisser les noms identiques à ceux utilisés par le service Web tiers ou vous pouvez les modifier en survolant le nom et en cliquant sur le bouton Modifier .

Valeur par défaut

Cochez la case de cette colonne si vous souhaitez spécifier une valeur par défaut pour le champ. Saisissez la valeur par défaut dans le champ qui apparaît après avoir coché la case.

Si vous souhaitez fournir une valeur par défaut qui ne peut pas être remplacée d'un flux, cochez la case de la colonne Valeur par défaut et décochez la case correspondante de la colonne Requête. Cela masque le champ des flux tout en fournissant la valeur par défaut dans la requête auprès du service Web externe. Cela peut être utile si vous disposez d'une clé d'accès que vous devez fournir dans chaque requête. Par exemple :

Charger un schéma

Choisissez cette option si vous disposez d'un schéma XML qui définit la structure des données que vous devez envoyer au service Web dans l'opération POST ou PUT. Après avoir sélectionné cette option, accédez au fichier de schéma.

Fournir un échantillon

Choisissez cette option si vous disposez d'un exemple de données que vous souhaitez envoyer au service Web dans l'opération POST ou PUT. Après avoir sélectionné cette option, vous pouvez saisir l'exemple ou coller l'exemple dans la fenêtre.

Une fois que vous fournissez un schéma ou un échantillon, cochez la case en regard de chaque élément de données que vous souhaitez rendre disponible dans le stage de flux.

Voici quelques conseils pour saisir des échantillons de données :

• Il est inutile d'entrer des données dans tous les champs. Si un champ est laissé vide, une chaîne vide est utilisée pour l'aperçu.
• Si vous souhaitez obtenir un aperçu de l'effet de la transmission de la valeur par défaut ou d'une valeur nulle dans un champ, cliquez sur l'icône Désactiver en regard du champ :
  
  .Si vous avez défini une valeur par défaut pour le champ dans l'onglet Requête, la valeur par défaut est utilisée. Si vous n'avez pas défini de valeur par défaut, une valeur nulle est utilisée.
• Vous pouvez prévisualiser plusieurs enregistrements à la fois. Pour ajouter un enregistrement, cliquez sur le bouton Ajouter .
• Vous pouvez importer des données de test à partir d'un fichier. Pour importer des données, cliquez sur le bouton Importer . Remarques :
  • La première ligne du fichier doit être un enregistrement d'en-tête. Les noms de champ dans l'en-tête doivent correspondre au nom de champ requis par le service.
  • Le nombre maximal d'enregistrements qui peut être importé est de cinq.
  • Si le fichier utilise un espace comme séparateur de champ, les valeurs de champ doivent être comprises entre guillemets. Voici un exemple de fichier qui utilise un espace comme séparateur de champ :

    AddressLine1 AddressLine2 City StateProvince PostalCode
    "One Global View" "" "Troy" "NY" "12180"
    "3001 Summer St" "" "Stamford" "CT" "06926"
    "224 N Michigan Ave" "Suite 300" "Chicago" "IL" ""

• Pour supprimer tous les enregistrements, cliquez sur le bouton Supprimer
  
  tout en haut de la zone d'aperçu.
• Pour supprimer un enregistrement particulier, passez la souris sur le nom de l'enregistrement d'entrée (par exemple, « enregistrement d'entrée 1 ») et cliquez sur le bouton Supprimer
  
  en regard du nom de l'enregistrement.