Exposition d'un service sous forme de service Web

Les services Spectrum™ Technology Platform peuvent être mis à disposition sous forme de services Web REST et/ou SOAP. Pour mettre un service à disposition sous forme de service Web sur votre serveur, procédez comme suit :

  1. Ouvrez Enterprise Designer.
  2. Ouvrez le service que vous souhaitez exposer sous forme de service Web.
  3. Accédez à Modifier > Options de services Web.
  4. Pour rendre le service disponible sous forme de service Web SOAP, cochez la case Exposer sous forme de service Web SOAP.
  5. Pour rendre le service disponible sous forme de service Web REST, cochez la case Exposer sous forme de service Web REST et procédez comme suit.
    1. Si vous souhaitez remplacer la destination par défaut, indiquez la destination que vous souhaitez utiliser dans le champ Chemin d'accès.

      Le chemin d'accès est facultatif. Par défaut, la destination d'un service Web REST est la suivante :

      http://server:port/rest/service_name/results.qualifier

      Si vous souhaitez utiliser une autre destination, le chemin d'accès que vous indiquez est ajouté après le nom de service. Par exemple, si vous spécifiez Amériques/Expédition dans le champ Chemin d'accès, votre destination JSON sera semblable à ce qui suit :

      http://myserver:8080/rest/MyService/Americas/Shipping/results.json

      Vous pouvez utiliser des champs et des options du dataflow comme noms de variable dans le chemin d'accès en cliquant sur le menu déroulant Insérer variable et en sélectionnant le champ ou l'option que vous souhaitez utiliser. La variable est représentée dans le chemin d'accès à l'aide de la notation ${Option.Name} pour les options de dataflow et de la notation ${Data.Name} pour les champs de dataflow.

    2. Par défaut, les services Web REST prennent en charge la méthode GET et renvoient des données aux formats XML et JSON. Vous pouvez définir des méthodes HTTP et des formats de sortie supplémentaires en cliquant sur Ajouterpour ajouter une ressource au service Web.
      Quand vous ajoutez une ressource, vous pouvez sélectionner la méthode HTTP (GET ou POST). Les formats de données pris en charge sont répertoriés ci-dessous. Il se peut que vous ne disposiez pas de tous ces formats, car certains formats ne sont disponibles que si certains modules sont installés sur votre serveur Spectrum™ Technology Platform.
      XML
      Format XML par défaut. Utilisez ce format si vous souhaitez utiliser XML comme format dans les requêtes et les réponses et qu'il n'existe aucun format XML spécialisé pour le type de données que vous souhaitez traiter.
      JSON
      Format JSON par défaut. Utilisez ce format si vous souhaitez utiliser JSON comme format dans les requêtes et les réponses et qu'il n'existe aucun format JSON spécialisé pour le type de données que vous souhaitez traiter.
      GeoJSON
      Format JSON spécialisé approprié aux services qui gèrent des données géographiques. La prise en charge est garantie uniquement pour Géométrie et pour les types de plate-forme natifs suivants :
      • booléen
      • double
      • flottant
      • integer
      • bigdecimal
      • long
      • string
      • date
      • time
      • datetime
      • timespan

      Si vous tentez d'exposer un flux avec tout autre type, vous ne pouvez pas spécifier GeoJSON (une erreur s'affiche lors de la conception). En outre, GeoJSON accepte une seule géométrie. Si la sortie contient plusieurs champs de géométrie, le système recherche un champ appelé « geometry » suivi d'un champ appelé « obj ». Si ces champs n'existent pas, le premier champ de géométrie est sélectionné.

    3. Cliquez sur OK.

      La nouvelle ressource est ajoutée au service Web.

  6. Cliquez sur OK lorsque vous avez terminé de configurer les options de service Web.
  7. Cliquez sur l'ampoule grise de la barre d'outils pour exposer le service.

    Lorsqu'un dataflow est exposé, le bouton de l'ampoule dans la barre d'outils Enterprise Designer indique que le dataflow est exposé comme indiqué ici :

Pour vérifier que le service est maintenant exposé sous forme de service Web, accédez à l'une des URL suivantes :
  • Pour REST : http://server:port/rest
  • Pour SOAP : http://server:port/soap

serveur est le nom de l'adresse IP de votre serveur Spectrum™ Technology Platform et port le port utilisé pour la communication HTTP.