Documentación de API también está disponible.
El marco de integración incluye una capa de integración con una API. Esto le permite crear componentes AEM para las capacidades de comercio electrónico (independientemente de su motor de comercio electrónico específico). También le permite utilizar la base de datos CRX interna o conectar un sistema de comercio electrónico y extraer datos de productos en AEM.
Se proporcionan varios componentes de AEM listos para usar para utilizar la capa de integración. Actualmente son:
Para la búsqueda, se proporciona un vínculo de integración que le permite utilizar la búsqueda de AEM, una búsqueda de terceros o una combinación de ellos.
El marco de comercio electrónico se puede utilizar con cualquier solución de comercio electrónico; el motor utilizado debe identificarse mediante AEM, incluso cuando se utiliza el motor genérico AEM:
Los motores de comercio electrónico son servicios de OSGi que admiten el CommerceService
interfaz
commerceProvider
propiedad serviceAEM admite Resource.adaptTo()
para CommerceService
y Product
La variable adaptTo
la implementación busca un cq:commerceProvider
en la jerarquía del recurso:
A cq:Commerce
mixin se usa de modo que la variable cq:commerceProvider
se puede agregar a recursos con establecimiento inflexible de tipos.
La variable cq:commerceProvider
también se utiliza para hacer referencia a la definición de fábrica de comercio apropiada.
cq:commerceProvider
con el valor geometrixx se correlacionará con la configuración OSGi para Day CQ Commerce Factory for Geometrixx-Outdoors (com.adobe.cq.commerce.hybris.impl.GeoCommerceServiceFactory
), donde el parámetro commerceProvider
también tiene el valor geometrixx
.En una instalación de AEM estándar se requiere una implementación específica, por ejemplo:
cq:commerceProvider = geometrixx |
ejemplo de geometrixx; esto incluye extensiones mínimas para la API genérica |
/etc/commerce/products/geometrixx-outdoors
+ cq:commerceProvider = geometrixx
+ adobe-logo-shirt
+ cq:commerceType = product
+ price = 12.50
+ adobe-logo-shirt_S
+ cq:commerceType = variant
+ size = S
+ adobe-logo-shirt_XL
+ cq:commerceType = variant
+ size = XL
+ price = 14.50
Con CRXDE Lite puede ver cómo se gestiona esto en el componente de producto para la implementación genérica de AEM:
/apps/geometrixx-outdoors/components/product
Una sesión para almacenar información relacionada con el carro de compras del cliente.
La variable CommerceSession:
Es propietario del carro de compras
realiza añadir/quitar/etc
realiza los distintos cálculos en el carro de compras;
commerceSession.getProductPriceInfo(Product product, Predicate filter)
Persistencia de los propietarios del pedido datos:
CommerceSession.getUserContext()
Puede recuperar o actualizar los detalles de la entrega mediante updateOrder(Map<String, Object> delta)
También posee el pago conexión de procesamiento
También posee el cumplimiento connection
Un solo producto puede tener varias variaciones; por ejemplo, puede variar según el color o el tamaño. Un producto debe definir qué propiedades impulsan la variación; los llamamos ejes de variante.
Sin embargo, no todas las propiedades son ejes de variante. Las variaciones también pueden afectar a otras propiedades; por ejemplo, el precio puede depender del tamaño. El comprador no puede seleccionar estas propiedades y, por lo tanto, no se consideran ejes de variante.
Cada producto o variante está representado por un recurso y, por lo tanto, asigna 1:1 a un nodo de repositorio. Es un corolario que un producto específico o una variante se puedan identificar de forma única por su ruta.
Cualquier recurso de producto puede representarse mediante un Product API
. La mayoría de las llamadas que se hacen en la API del producto son específicas para variaciones (aunque las variaciones pueden heredar valores compartidos de un antecesor), pero también hay llamadas que enumeran el conjunto de variaciones ( getVariantAxes()
, getVariants()
, etc.).
De hecho, los ejes de una variante están determinados por lo que sea Product.getVariantAxes()
devuelve:
cq:productVariantAxes
)Aunque los productos (en general) pueden tener muchos ejes de variante, el componente de producto listo para usar solo gestiona dos:
size
más uno más
Esta variante adicional se selecciona mediante la variable variationAxis
propiedad de la referencia del producto (normalmente color
para Geometrixx Outdoors).
En general:
Los datos de PIM se encuentran en /etc
Referencias de producto en /content
.
Debe haber un mapa 1:1 entre las variaciones del producto y los nodos de datos del producto.
Las referencias del producto también deben tener un nodo para cada variación presentada, pero no es necesario presentar todas las variaciones. Por ejemplo, si un producto tiene variaciones S, M o L, los datos del producto podrían ser:
etc
commerce
products
shirt
shirt-s
shirt-m
shirt-l
Mientras que un catálogo "Big and Tall" solo puede tener:
content
big-and-tall
shirt
shirt-l
Por último, no es necesario utilizar los datos del producto. Puede colocar todos los datos del producto debajo de las referencias en el catálogo; pero, en realidad, no puede tener varios catálogos sin duplicar todos los datos del producto.
API
public interface Product extends Adaptable {
public String getPath(); // path to specific variation
public String getPagePath(); // path to presentation page for all variations
public String getSKU(); // unique ID of specific variation
public String getTitle(); // shortcut to getProperty(TITLE)
public String getDescription(); // shortcut to getProperty(DESCRIPTION)
public String getImageUrl(); // shortcut to getProperty(IMAGE_URL)
public String getThumbnailUrl(); // shortcut to getProperty(THUMBNAIL_URL)
public <T> T getProperty(String name, Class<T> type);
public Iterator<String> getVariantAxes();
public boolean axisIsVariant(String axis);
public Iterator<Product> getVariants(VariantFilter filter) throws CommerceException;
}
/**
* Interface for filtering variants and AxisFilter provided as common implementation
*
* The <code>VariantFilter</code> is used to filter variants,
* e.g. when using {@link Product#getVariants(VariantFilter filter)}.
*/
public interface VariantFilter {
public boolean includes(Product product);
}
/**
* A {@link VariantFilter} for filtering variants by the given
* axis and value. The following example returns a list of
* variant products that have a value of <i>blue</i> on the
* <i>color</i> axis.
*
* <p>
* <code>product.getVariants(new AxisFilter("color", "blue"));</code>
*/
public class AxisFilter implements VariantFilter {
private String axis;
private String value;
public AxisFilter(String axis, String value) {
this.axis = axis;
this.value = value;
}
/**
* {@inheritDoc}
*/
public boolean includes(Product product) {
ValueMap values = product.adaptTo(ValueMap.class);
if(values != null) {
String v = values.get(axis, String.class);
return v != null && v == value;
}
return false;
}
}
Mecanismo General de Almacenamiento
Los nodos de producto son nt:unstructured.
Un nodo de producto puede ser:
Una referencia, con los datos del producto almacenados en otra parte:
productData
, que señala a los datos del producto (normalmente, en /etc/commerce/products
).Un producto en sí:
productData
propiedad.Estructura de producto AEM genérica
+ banyan_shirt
- cq:commerceType = product
- cq:productAttributes = [jcr:title, jcr:description, size, price, color]
- cq:productVariantAxes = [color, size]
- jcr:title = Banyan Shirt
- jcr:description = Flowery, all-cotton shirt.
- price = 14.00
+ banyan_shirt_s
- cq:commerceType = variant
- size = S
+ banyan_shirt_s_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_s_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_m
- cq:commerceType = variant
- size = M
+ banyan_shirt_m_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_m_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_l
- cq:commerceType = variant
- size = L
+ banyan_shirt_l_red
- cq:commerceType = variant
- color = red
+ banyan_shirt_l_blue
- cq:commerceType = variant
- color = blue
+ banyan_shirt_xl
- cq:commerceType = variant
- size = XL
- price = 18.00
Componentes
El carro de compras es propiedad del CommerceSession:
CommerceSession
ejecuta add, remove, etc.CommerceSession
también realiza los distintos cálculos del carro de compras.CommerceSession
también aplica vales y promociones que se han disparado al carro de compras.Aunque no está directamente relacionado con el carro de compras, la variable CommerceSession
también debe proporcionar información de precios de catálogo (ya que posee precios)
Los precios pueden tener varios modificadores:
Los modificadores están totalmente abiertos con la siguiente interfaz:
int CommerceSession.getQuantityBreakpoints(Product product)
String CommerceSession.getProductPrice(Product product)
Almacenamiento
Almacenamiento
Personalización
La personalización siempre debe impulsarse a través de la variable ClientContext.
Un ClientContext /version/
del carro de compras se crea en todos los casos:
CommerceSession.addCartEntry()
método.A continuación se muestra un ejemplo de información del carro de compras en el carro de ClientContexts:
Datos de carro de compras y pedidos
La variable CommerceSession
posee los tres elementos siguientes:
Contenido del carro de compras
La API corrige el esquema de contenido del carro de compras:
public void addCartEntry(Product product, int quantity);
public void modifyCartEntry(int entryNumber, int quantity);
public void deleteCartEntry(int entryNumber);
Precio
La API también corrige el esquema de precios:
public String getCartPreTaxPrice();
public String getCartTax();
public String getCartTotalPrice();
public String getOrderShipping();
public String getOrderTotalTax();
public String getOrderTotalPrice();
Detalles del pedido
Sin embargo, los detalles del pedido son not solucionado por la API:
public void updateOrderDetails(Map<String, String> orderDetails);
public Map<String, String> getOrderDetails();
public void submitOrder();
Cálculos de envío
Los formularios de pedido a menudo necesitan presentar varias opciones de envío (y precios).
Los precios pueden basarse en artículos y detalles del pedido, como peso o dirección de entrega.
La variable CommerceSession
tiene acceso a todas las dependencias, por lo que se puede tratar de forma similar a los precios de los productos:
CommerceSession
es propietario de precios de envío.updateOrder(Map<String, Object> delta)
para recuperar/actualizar los detalles de la entrega.Siguiendo el modelo de API de servicio estándar, el proyecto de comercio electrónico proporciona un conjunto de API relacionadas con la búsqueda que pueden ser implementadas por motores de comercio individuales.
Actualmente, solo el motor híbris implementa la API de búsqueda predeterminada.
Sin embargo, la API de búsqueda es genérica y cada CommerceService puede implementarla individualmente.
Por lo tanto, aunque la implementación genérica proporcionada de forma predeterminada no implementa esta API, puede ampliarla y añadir la funcionalidad de búsqueda.
El proyecto eCommerce contiene un componente de búsqueda predeterminado, ubicado en:
/libs/commerce/components/search
Esto hace uso de la API de búsqueda para consultar el motor de comercio seleccionado (consulte Selección del motor de comercio electrónico):
El proyecto principal proporciona varias clases genéricas/de ayuda:
CommerceQuery
Se utiliza para describir una consulta de búsqueda (contiene información sobre el texto de la consulta, la página actual, el tamaño de la página, el orden y las facetas seleccionadas). Todos los servicios de comercio electrónico que implementan la API de búsqueda recibirán instancias de esta clase para realizar su búsqueda. A CommerceQuery
se puede crear una instancia desde un objeto de solicitud ( HttpServletRequest
).
FacetParamHelper
Es una clase de utilidad que proporciona un método estático: toParams
- que se utiliza para generar GET
cadenas de parámetros de una lista de facetas y un valor alternado. Esto resulta útil en la interfaz de usuario, donde debe mostrar un hipervínculo para cada valor de cada faceta, de modo que cuando el usuario haga clic en el hipervínculo, se alterne el valor respectivo (es decir, si se seleccionó, se eliminará de la consulta y se añadirá de lo contrario). Esto se ocupa de toda la lógica de gestionar facetas de varios valores o de un solo valor, valores anuladores, etc.
El punto de entrada para la API de búsqueda es la CommerceService#search
método que devuelve un CommerceResult
objeto. Consulte la documentación de la API para obtener más información sobre este tema.
Cupones:
Un Cupón es un componente basado en páginas que se crea/edita con la consola Sitios web y se almacena en:
/content/campaigns
Suministro de cupones:
Los cupones no tienen su propio valor en la fecha/hora y fuera de ella, pero utilizan los de sus campañas principales.
Los motores de comercio exterior también pueden suministrar vales; requieren un mínimo de:
isValid()
methodLa variable Cupón componente ( /libs/commerce/components/voucher
) proporciona:
Promociones:
Una promoción es un componente basado en páginas que se crea o edita con la consola Sitios web y se almacena en:
/content/campaigns
Oferta de promociones:
Puede conectar promociones a una campaña para definir la fecha y las horas de activación y desactivación.
Puede conectar promociones a una experiencia para definir sus segmentos.
Las promociones que no estén conectadas a una experiencia no se activarán por sí solas, pero aún pueden ser activadas por un Cupón.
El componente Promoción ( /libs/commerce/components/promotion
) contiene:
Se suministran dos controladores de promoción predeterminados:
DiscountPromotionHandler
, que aplica un descuento absoluto o porcentual en todo el carro de comprasPerfectPartnerPromotionHandler
, que aplica un descuento absoluto o porcentual del producto si el producto asociado también está en el carro de comprasEl ClientContext SegmentMgr
resuelve los segmentos y el ClientContext CartMgr
resuelve las promociones. Se activarán todas las promociones que estén sujetas a al menos un segmento resuelto.
La adición/eliminación de un vale de un carro se realiza mediante la variable CommerceSession
API:
/**
* Apply a voucher to this session's cart.
*
* @param code the voucher's code
* @throws CommerceException
*/
public void addVoucher(String code) throws CommerceException;
/**
* Remove a voucher that was previously added with {@link #addVoucher(String)}.
*
* @param code the voucher's code
* @throws CommerceException
*/
public void removeVoucher(String code) throws CommerceException;
/**
* Get a list of vouchers that were added to this cart via {@link #addVoucher(String)}.
*
* @throws CommerceException
*/
public List<Voucher> getVouchers() throws CommerceException;
De esta manera, el CommerceSession
es responsable de comprobar si existe un cupón y si se puede aplicar o no. Esto puede ser para cupones que solo se pueden aplicar si se cumple una determinada condición; por ejemplo, cuando el precio total del carro de compras es bueno a 100 $). Si no se puede aplicar un cupón por ningún motivo, la variable addVoucher
generará una excepción. Además, el CommerceSession
es responsable de actualizar los precios del carro de compras después de añadir o eliminar un vale.
La variable Voucher
es una clase similar a un bean que contiene campos para:
La variable AbstractJcrCommerceSession
puede aplicar cupones. Los vales devueltos por la clase getVouchers()
son instancias de cq:Page
que contiene un nodo jcr:content con las siguientes propiedades (entre otras):
sling:resourceType
(Cadena): esto debe ser commerce/components/voucher
jcr:title
(Cadena): para la descripción del cupón
code
(Cadena): el código que debe introducir el usuario para aplicar este cupón
promotion
(Cadena): la promoción que se aplicará; p. ej. /content/campaigns/geometrixx-outdoors/article/10-bucks-off
Los controladores de promociones son servicios OSGi que modifican el carro de compras. El carro admitirá varios vínculos que se definirán en la variable PromotionHandler
interfaz.
/**
* Apply promotion to a cart line item. The method returns a discount
* <code>PriceInfo</code> instance or <code>null</code> if no discount
* was applied.
* @param commerceSession The commerce session
* @param promotion The configured promotion
* @param cartEntry The cart line item
* @return A discounted <code>PriceInfo</code> or <code>null</code>
*/
public PriceInfo applyCartEntryPromotion(CommerceSession commerceSession,
Promotion promotion, CartEntry cartEntry)
throws CommerceException;
/**
* Apply promotion to an order. The method returns a discount
* <code>PriceInfo</code> instance or <code>null</code> if no discount
* was applied.
* @param commerceSession The commerce session
* @param promotion The configured promotion
* @return A discounted <code>PriceInfo</code> or <code>null</code>
*/
public PriceInfo applyOrderPromotion(CommerceSession commerceSession, Promotion promotion)
throws CommerceException;
public PriceInfo applyShippingPromotion(CommerceSession commerceSession, Promotion promotion)
throws CommerceException;
/**
* Allows a promotion handler to define a custom, author-oriented message for a promotion.
* The {@link com.adobe.cq.commerce.common.promotion.PerfectPartnerPromotionHandler}, for instance,
* uses this to list the qualifying pairs of products in the current cart.
* @param commerceSession
* @param promotion
* @return A message to display
* @throws CommerceException
*/
public String getMessage(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) throws CommerceException;
/**
* Informs the promotion handler that something under the promotions root has been edited, and the handler
* should invalidate any caches it might be keeping.
*/
public void invalidateCaches();
Se proporcionan tres controladores de promoción predeterminados:
DiscountPromotionHandler
aplica un descuento absoluto o porcentual en todo el carro de comprasPerfectPartnerPromotionHandler
aplica un descuento absoluto o porcentual del producto si el socio del producto también está en el carro de comprasFreeShippingPromotionHandler
aplica envío gratuito