Sintaxis básica de URL

Todos los URL del flujo de compra de HCL Commerce tienen la misma sintaxis básica.

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

A continuación se proporciona un ejemplo:

Ejemplo del diagrama de sintaxis lineal.

Para leer estos diagramas de sintaxis de tipo lineal, comience en la esquina superior izquierda y siga la línea (imagínese que es una vía de tren). Tenga en cuenta los siguientes convenios:

  • El host_name y path se determinan en función de cómo se ha instalado HCL Commerce. El host_name es el nombre completo del servidor de HCL Commerce. La path es la vía de acceso de configuración. Por ejemplo,
    http://myhostname/webapp/wcs/stores/servlet/DynaCacheInvalidation?clear=true
    
    Donde myhostname es el host_name para el URL y webapp/wcs/stores/servlet/ es la path.
  • El delimitador que va a continuación del nombre de mandato es ?. El delimitador entre parámetros sucesivos es &. No es necesario que utilice el signo & antes del primer parámetro. El valor del parámetro suele aparece en los diagramas de sintaxis como S para serie o I para entero. Si un parámetro puede tener únicamente un valor true o false, el valor predeterminado se especifica en el diagrama. Si un parámetro requiere códigos predefinidos o si impone restricciones no evidentes en el tipo de datos, este requisito o restricción se explica en la descripción. Al leer la línea de izquierda a derecha, cualquier parámetro que está en la línea principal, como por ejemplo URL, no se puede evitar. Esta ubicación de un parámetro identifica que el parámetro es obligatorio.
  • Si un parámetro está fuera de la línea principal, como por ejemplo langId, y se puede evitar, el parámetro es opcional.
  • Si un parámetro tiene una línea que regresa al lado izquierdo, como listId, esto indica que el parámetro puede utilizarse repetidamente. Por ejemplo:
    &listId=1&listId=2&listId=3
    
El siguiente diagrama de sintaxis ilustra conjuntos alternativos de parámetros obligatorios: puede utilizar:
&logonId=s&challengeAnswer=s 
O también puede utilizar
&logonPassword=s&logonPasswordOld=s&logonPasswordVerify=s

Ejemplo de un diagrama de sintaxis con parámetros obligatorios alternativos.

Valores de parámetros

Algunos parámetros comunes están disponibles para la mayoría de los mandatos:

storeId
Asocia el mandato a una tienda específica. Esta asociación de tienda es especialmente útil con los mandatos que operan a nivel de centro comercial, ya que obliga al mandato a operar únicamente dentro del ámbito de la tienda.
langId
Especifica el idioma que se utiliza durante el mandato. Los valores del parámetro se almacenan en la tabla LANGUAGE. El idioma que se especifica sustituye al idioma predeterminado del usuario, si está soportado. De lo contrario, si el idioma especificado no está soportado, entonces se utiliza el idioma predeterminado de la tienda o del sitio.
forUser
Especifica el ID de conexión de un usuario para quien otro usuario está llevando a cabo acciones. Este parámetro solo lo puede utilizar una persona que tenga autorización para procesar pedidos, como un Representante de servicio al cliente, un Supervisor de servicio al cliente, un Director de operaciones de B2C, un Director de logística de B2C, un Comerciante de B2C o un Vendedorde B2C . Este parámetro es útil cuando un cliente llama a un centro de atención telefónica y solicita ayuda para completar una compra. El operador del centro de asistencia telefónica puede entonces iniciar la sesión y completar el pedido utilizando la identidad del cliente que llama.
forUserId
Igual que forUser, pero el usuario se identifica mediante el ID de usuario interno que aparece en la tabla USERS.
URL
La dirección web a la que se llama cuando el mandato se ejecuta satisfactoriamente. El valor de este parámetro se determina de la siguiente manera: Empiece con los parámetros de entrada del mandato, excepto URL. Añada, sustituyéndolos cuando se produzca un conflicto de nombres, los pares nombre-valor adicionales generados por este mandato. Finalmente, añada, sustituyéndolos cuando se produzca un conflicto de nombres, los pares nombre-valor que se encuentran en el URL.
errorTaskView
El nombre de la vista a la que se redirige el navegador si se produce algún problema. Si no se especifica, se utiliza la vista de error predeterminada asociada a una excepción determinada.

Ejemplo

En el ejemplo de un URL, el URL a menudo abarca varias líneas. Para facilitar la lectura, estas se organizan como en el siguiente URL:

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

Un mandato de URL aparece normalmente en una sola línea.