Syntaxe d'URL de base

Toutes les URL de flux d'achats HCL Commerce suivent la même syntaxe de base.

http://host_name/path/Command?parameter1=value&parameter2=value&parameter3=value

En voici une représentation :

Exemple de diagramme syntaxique.

Pour lire ces diagrammes syntaxiques, commencez dans le coin supérieur gauche, et suivez la ligne (comme si vous suiviez une ligne ferroviaire). N'oubliez pas les conventions suivantes :

Le host_name et le path sont déterminés en fonction de la façon dont HCL Commerce est installé. Le host_name est le nom qualifié complet de votre serveur HCL Commerce. Le path est le chemin de configuration : Par exemple,
```
http://myhostname/webapp/wcs/stores/servlet/DynaCacheInvalidation?clear=true
```
Où myhostname est le host_name pour l'URL, et webapp/wcs/stores/servlet/ est le path.
Délimiteur après le nom de commande ?. Le délimiteur entre les paramètres successifs est &. Vous n'avez pas à utiliser & avant le premier paramètre. La valeur du paramètre est généralement indiquée dans les diagrammes syntaxiques comme S pour la chaîne ou I pour un entier. Si un paramètre peut avoir une valeur de seulement true ou false, la valeur par défaut est spécifiée dans le diagramme. Si un paramètre nécessite des codes prédéfinis ou s'il impose des restrictions non évidentes sur le type de données, cette exigence ou restriction est expliquée dans la description. Lorsque vous lisez la ligne de gauche à droite, tout paramètre qui se trouve sur la ligne principale, comme l'URL, ne peut être évité. Cet emplacement d'un paramètre identifie que le paramètre est obligatoire.
Si un paramètre est en dehors ligne principale, comme langId, et peut être évité, le paramètre est facultatif.
Si un paramètre a une ligne qui retourne sur le site de gauche, comme listId, cela indique que le paramètre peut être utilisé à plusieurs reprises, par exemple :
```
&listId=1&listId=2&listId=3
```

Le diagramme syntaxique suivant illustre d'autres ensembles de paramètres obligatoires : vous utilisez :

&logonId=s&challengeAnswer=s

Ou bien :

&logonPassword=s&logonPasswordOld=s&logonPasswordVerify=s

Exemple de diagramme syntaxique avec d'autres paramètres obligatoires.

Valeurs des paramètres

Certains paramètres courants sont disponibles pour la plupart des commandes :

storeId: Associe la commande à un magasin spécifique. Cette association de magasins est particulièrement utile avec des commandes qui fonctionnent au niveau du centre commercial parce qu'elle force la commande à ne s'appliquer qu'à la portée du magasin.
langId: Spécifie la langue utilisée pendant la commande. Les valeurs du paramètre sont stockées dans le tableau LANGUAGE. La langue spécifiée remplace la langue par défaut de l'utilisateur si elle est prise en charge. Sinon, si la langue spécifiée n'est pas prise en charge, la langue par défaut du magasin ou du site est utilisée.
forUser: Spécifie l'ID de connexion d'un utilisateur pour lequel des actions sont prises par un autre utilisateur. Le paramètre ne peut être utilisé que par une personne ayant l'autorisation de traiter les commandes, comme un représentant du service clientèle, un responsable du service clientèle, un gestionnaire des opérations , un responsable de la logistique , un commerçant , un vendeur . Le paramètre est utile dans un paramètre de centre d'appels si un client demande de l'aide pour effectuer un achat. L'opérateur du centre d'appels se connecte ensuite et termine la commande en utilisant l'identification du client appelant.
forUserId: Identique à forUser, mais identifiant l'utilisateur par son ID interne, répertorié dans la table USERS.
URL: Adresse Web appelée lorsque la commande réussit. La valeur de ce paramètre est déterminée comme suit : Commencez par les paramètres d'entrée de la commande, à l'exception de l'URL. Ajoutez, ou remplacez en cas de conflit de noms, toutes les paires nom-valeur supplémentaires produites par cette commande. Enfin, ajoutez, ou remplacez en cas de conflit de noms, les paires nom-valeur trouvées dans l'URL.
errorTaskView: Nom de l'affichage vers lequel le navigateur est redirigé en cas de problème. S'il n'est pas spécifié, l'affichage d'erreur par défaut associé à une exception particulière est utilisé.

Exemple

Dans l'exemple d'une URL, l'URL s'étend souvent sur plusieurs lignes. Pour des raisons de lisibilité, elles sont disposées comme l'URL suivante :

http://myhostname/webapp/wcs/stores/servlet/AddressUpdate?addressId=128
     &firstName=Jeffery&URL=/webapp/wcs/stores/servlet/

Une commande URL apparaît généralement sur une seule ligne.