Fonctionnalités
Le champ de ShopCatalog est doublement restreint :
le Web Service a pour objectif d’aider à construire des encarts publicitaires dans les pages de contenu d’un site associant contenu et système de vente. Il ne sert donc qu’à afficher des données du catalogue sous une forme simplifiée. Il ne permet pas de remplir un panier ou de conduire une transaction. Ces fonctionnalités restent du ressort du système de vente.
le Web Service est relatif à une boutique donnée, car il n’accède qu’aux données d’une seule boutique. Pour une base de données BiDiShop’s (qui porte sur plusieurs boutiques, contrairement à une base de données osCommerce qui n’est relative qu’à une seule boutique), l’Id de la boutique est fixé comme paramètre interne par l’administrateur du service. Cela signifie qu’un Web Service doit être installé pour chaque boutique, qu’il s’agisse d’osCommerce ou de BiDiShops.
La notion de session n’est pas gérée par ce Web Service. Cela signifie que tous les paramètres nécessaires à une requête doivent être passés dans la requête, et ne seront pas mémorisés d’une requête sur l’autre. Tous les paramètres sont obligatoires, même si des valeurs neutres sont prévues.
Pour des raisons de sécurité, les paramètres de la connexion à la base de données de la boutique sont gérés par l’administrateur du système et ne sont pas accessibles de l’extérieur.
Le fait que le Web Service ne permette pas de mettre le catalogue à jour ne doit pas être considéré comme une limitation, mais comme une caractéristique essentielle allant dans le sens de la sécurité des données du catalogue. Autrement dit, BiDiShops ne fera jamais appel à des Web Services publics pour la mise à jour des données, mais à des applications spécifiquement sécurisées (voir Utilisation d’osCDataViewer).
Ce service est une aide à la construction de fils RSS et à l’affichage des données du catalogue d’une base de données répondant au standard osCommerce.
Opérations supportées par le Web Service ShopCatalog
getProductsLink Retourne l’URL, le chemin, la page et le paramètre vers le détail du produit. Il suffit d’ajouter l’Id du produit pour obtenir la page de détail du produit.
getWsName Retourne le Nom et la version de ce Web Service.
getShopURL Retourne l’URL du site marchand.
getRSS Retourne un fil des produits sélectionnés à l’aide des paramètres suivants :
CatId : Catégorie du produit (les sous-catégories sont incluses).
Keys : Mots clefs à chercher dans le titre, la description et le modèle.
LangId : Id du langage.
Afin de maintenir la performance du système, les limitations suivantes ont été imposées par conception :
Le nombre de produits retournés par getRSS est limité à 100.
Le résultat de getRSS est placé en cache pour une durée de 1000 secondes.
getXMLProductsSimpleSearch Fonctionnellement identique à getRSS, mais retourne un fil suivant un schéma spécifique permettant de décrire les articles du catalogue de façon plus détaillée et exploitant la richesse d’osCommerce.
Les paramètres sont les mêmes que ceux de getRSS.
Les noms des données sont qualifiés par le préfixe "osc :".
Paramètre Keys, chaîne de recherche
Le paramètre Keys fournit des mots à rechercher dans le titre, la description ou le champ Model des articles du catalogue. Elle est le plus souvent limitée à un mot, mais peut combiner plusieurs mots de la façon suivante :
La recherche est effectuée pour chaque mot ou groupes de mots séparés par une virgule ou deux points. Les mots séparés autrement, en particulier avec un tiret ou un espace, restent groupés. (cela revient à l’opérateur OU).
Les mots groupés par un point sont combinés avec l’opérateur ET.
(A faire : donner des exemples).
Evolutions
Au state actuel, les Web Services ShopCatalog et ExShopCatalog doivent être considérés comme des prototypes en cours de développement. Cependant, l’opération getRSS retournant des données suivant le schéma XML/RSS 2.0 peut de ce fait être considérée comme stable.
En revanche, l’opération getXMLProductsSimpleSearch est appelée à évoluer rapidement. Elle devrait à terme suivre le schéma OASIS.
Ensuite :
Visualisation des fils RSS produits par les Web Services
En savoir plus sur ShopCatalog :
présentation formelle des fonctions et appels SOAP
description formelle au format WSDL
Exemple de syndication avec une boutique osCommerce
En savoir plus sur BiDiShops :
La syndication dans le système BiDiShops
Des Web Services pour osCommerce
du gestionnaire de la boutique de vérifier que du code hostile n’est pas introduit dans son catalogue ;