API 설명서도 사용할 수 있습니다.
통합 프레임워크는 API와 통합 레이어를 포함합니다. 이를 통해 특정 eCommerce 엔진과 별도로 eCommerce 기능을 위한 AEM 구성 요소를 작성할 수 있습니다. 또한 내부 CRX 데이터베이스를 사용하거나 eCommerce 시스템을 연결하고 제품 데이터를 AEM에 가져올 수도 있습니다.
통합 레이어를 사용하기 위해 즉시 사용 가능한 여러 AEM 구성 요소가 제공됩니다. 현재는 다음과 같습니다.
검색 시 AEM 검색, 타사 검색(예: Search & Promote) 또는 이들의 조합을 사용할 수 있는 통합 후크가 제공됩니다.
eCommerce 프레임워크는 모든 eCommerce 솔루션에서 사용할 수 있으며, AEM 일반 엔진을 사용하는 경우에도 AEM에서 사용 중인 엔진을 식별해야 합니다.
eCommerce Engine은 CommerceService
인터페이스를 지원하는 OSGi 서비스입니다
commerceProvider
서비스 속성으로 구분할 수 있습니다AEM에서는 CommerceService
및 Product
에 대해 Resource.adaptTo()
를 지원합니다
adaptTo
구현은 리소스의 계층에서 cq:commerceProvider
속성을 찾습니다.
cq:Commerce
mixin이 사용되므로 cq:commerceProvider
을(를) 강력한 형식의 리소스에 추가할 수 있습니다.
cq:commerceProvider
속성은 적절한 상거래 공장 정의를 참조하는 데에도 사용됩니다.
cq:commerceProvider
속성은 Day CQ Commerce Factory for Geometrixx-Outdoors(com.adobe.cq.commerce.hybris.impl.GeoCommerceServiceFactory
)에 대한 OSGi 구성과 상관 관계가 있습니다. 여기서 매개 변수 commerceProvider
에는 geometrixx
값도 있습니다.표준 AEM 설치에서는 다음과 같이 특정 구현이 필요합니다.
cq:commerceProvider = geometrixx |
geometrixx 예여기에는 일반 API에 대한 최소 확장만 포함됩니다 |
/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
CRXDE Lite을 사용하면 AEM 일반 구현의 제품 구성 요소에서 이 작업을 처리하는 방법을 확인할 수 있습니다.
/apps/geometrixx-outdoors/components/product
고객의 장바구니와 관련된 정보를 저장하는 세션입니다.
CommerceSession:
장바구니를 소유합니다.
추가/제거/등 수행
장바구니에서 다양한 계산을 수행합니다.
commerceSession.getProductPriceInfo(Product product, Predicate filter)
order 데이터의 지속성을 소유합니다.
CommerceSession.getUserContext()
updateOrder(Map<String, Object> delta)
을 사용하여 게재 세부 사항을 검색/업데이트할 수 있습니다.
또한 payment 처리 연결도 소유합니다
또한 fulfillment 연결을 소유합니다
단일 제품에는 여러 변형이 있을 수 있습니다.예를 들어 색상 및/또는 크기에 따라 다를 수 있습니다. 제품은 변형이 시작되는 속성을 정의해야 합니다.이 변형 축이라고 합니다.
그러나 일부 속성이 변형 축인 것은 아닙니다. 변형은 다른 속성에도 영향을 줄 수 있습니다.예를 들어 가격은 크기에 따라 달라질 수 있습니다. 이러한 속성은 쇼퍼에서 선택할 수 없으므로 변형 축으로 간주되지 않습니다.
각 제품 및/또는 변형은 리소스로 표시되므로 1:1을 저장소 노드에 매핑합니다. 특정 제품 및/또는 변형을 해당 경로로 고유하게 식별할 수 있는 것은 당연한 귀결입니다.
모든 제품 리소스는 Product API
으로 표시될 수 있습니다. 제품 API의 대부분의 호출은 변형별로 고유하지만(변형은 조상에서 공유 값을 상속할 수 있지만), 변형 세트( getVariantAxes()
, getVariants()
등)를 나열하는 호출도 있습니다.
사실상 변형 축은 Product.getVariantAxes()
이 반환하는 대로 결정됩니다.
cq:productVariantAxes
).제품(일반적으로)은 많은 변형 축을 가질 수 있지만 기본적으로 제공되는 제품 구성 요소는 두 개만 처리합니다.
size
하나 더
이 추가 변형은 제품 참조의 variationAxis
속성(일반적으로 Geometrixx Outdoors의 경우 color
)을 통해 선택됩니다.
일반적으로
PIM 데이터가 /etc
아래에 있습니다.
/content
아래의 제품 참조.
제품 변형과 제품 데이터 노드 사이에는 1:1 맵이 있어야 합니다.
제품 참조에는 표시된 각 변형에 대한 노드도 있어야 합니다. 하지만 모든 변형을 표시할 필요는 없습니다. 예를 들어 제품에 S, M, L 변형이 있는 경우 제품 데이터는 다음과 같을 수 있습니다.
etc
commerce
products
shirt
shirt-s
shirt-m
shirt-l
"크고 긴" 카탈로그만 있을 수 있지만
content
big-and-tall
shirt
shirt-l
마지막으로, 제품 데이터를 사용할 필요는 없습니다. 모든 제품 데이터를 카탈로그의 참조 아래에 배치할 수 있습니다.그러나 제품 데이터를 복제하지 않으면 실제로 여러 카탈로그를 가질 수는 없습니다.
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;
}
}
일반 스토리지 메커니즘
제품 노드는 구조화되지 않습니다.
제품 노드는 다음 중 하나일 수 있습니다.
제품 데이터가 다른 위치에 저장된 참조:
/etc/commerce/products
아래)를 가리키는 productData
속성이 포함됩니다.제품 자체:
productData
속성이 없습니다.AEM-일반 제품 구조
+ 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
구성 요소
장바구니는 CommerceSession:
에서 소유합니다
CommerceSession
에서는 추가, 제거 등을 수행합니다.CommerceSession
도 장바구니에서 다양한 계산을 수행합니다.CommerceSession
은 장바구니에 실행된 바우처와 프로모션도 적용합니다.직접 장바구니와 관련되지는 않지만, CommerceSession
은(는) 가격을 소유하므로 카탈로그 가격 정보를 제공해야 합니다
가격책정에 다음과 같은 몇 가지 수정자가 있을 수 있습니다.
수정자는 다음 인터페이스로 완전히 개방됩니다.
int CommerceSession.getQuantityBreakpoints(Product product)
String CommerceSession.getProductPrice(Product product)
저장 용량
저장 용량
개인화
개인화는 항상 ClientContext를 통해 제어되어야 합니다.
모든 경우에 장바구니의 ClientContext /version/
이 만들어집니다.
CommerceSession.addCartEntry()
메서드를 사용하여 제품을 추가해야 합니다.다음은 ClientContext 장바구니의 장바구니 정보의 예입니다.
장바구니 및 주문 데이터
CommerceSession
은 다음 세 가지 요소를 소유합니다.
장바구니 컨텐츠
장바구니 컨텐츠 스키마는 API로 수정되었습니다.
public void addCartEntry(Product product, int quantity);
public void modifyCartEntry(int entryNumber, int quantity);
public void deleteCartEntry(int entryNumber);
가격 책정
가격 책정 스키마는 API로도 수정되었습니다.
public String getCartPreTaxPrice();
public String getCartTax();
public String getCartTotalPrice();
public String getOrderShipping();
public String getOrderTotalTax();
public String getOrderTotalPrice();
주문 세부 사항
그러나 주문 세부 사항은 API에서 수정하지 않은 입니다.
public void updateOrderDetails(Map<String, String> orderDetails);
public Map<String, String> getOrderDetails();
public void submitOrder();
배송 계산
주문 양식은 종종 여러 배송 옵션(및 가격)을 제공해야 합니다.
가격은 중량 및/또는 배달 주소와 같은 주문 및 세부 사항을 기반으로 할 수 있습니다.
CommerceSession
은(는) 모든 종속성에 액세스할 수 있으므로 제품 가격과 유사한 방식으로 처리할 수 있습니다.
CommerceSession
은 배송 가격을 소유합니다.updateOrder(Map<String, Object> delta)
을 사용하여 게재 세부 사항을 검색/업데이트합니다.표준 서비스 API 모델에 따라 eCommerce 프로젝트는 개별 상거래 엔진에서 구현할 수 있는 검색 관련 API 세트를 제공합니다.
현재, hybris 엔진만 검색 API를 즉시 구현합니다.
그러나 검색 API는 제네릭이므로 각 CommerceService에서 개별적으로 구현할 수 있습니다.
따라서 기본적으로 제공되는 일반 구현에서 이 API를 구현하지 않지만, 이를 확장하고 검색 기능을 추가할 수 있습니다.
eCommerce 프로젝트에는 다음과 같은 기본 검색 구성 요소가 포함되어 있습니다.
/libs/commerce/components/search
이렇게 하면 검색 API를 사용하여 선택한 상거래 엔진을 쿼리합니다( eCommerce Engine Selection 참조).
핵심 프로젝트에서 제공하는 몇 가지 일반/도우미 클래스가 있습니다.
CommerceQuery
검색 쿼리를 설명하는 데 사용됩니다(쿼리 텍스트, 현재 페이지, 페이지 크기, 정렬 및 선택한 패싯에 대한 정보가 포함됨). 검색 API를 구현하는 모든 eCommerce 서비스는 검색을 수행하기 위해 이 클래스의 인스턴스를 수신합니다. CommerceQuery
은 요청 개체( HttpServletRequest
)에서 인스턴스화할 수 있습니다.
FacetParamHelper
패싯 목록과 하나의 전환된 값에서 GET
매개 변수 문자열을 생성하는 데 사용되는 하나의 정적 메서드 toParams
를 제공하는 유틸리티 클래스입니다. 이 기능은 UI 측에서 각 패싯의 각 값에 대한 하이퍼링크를 표시해야 할 때 사용자가 하이퍼링크를 클릭하면 각 값이 전환됩니다(즉, 선택한 경우 쿼리에서 제거되고 그렇지 않으면 추가됨). 이렇게 하면 여러/단일 값을 갖는 패싯을 처리하고 값을 재정의하는 등의 모든 로직이 관리됩니다.
검색 API의 시작 지점은 CommerceResult
개체를 반환하는 CommerceService#search
메서드입니다. 이 항목에 대한 자세한 내용은 API 설명서 를 참조하십시오.
바우처:
바우처는 웹 사이트 콘솔로 작성/편집되며 아래에 저장되는 페이지 기반 구성 요소입니다.
/content/campaigns
바우처 공급:
바우처는 설정 및 해제 날짜/시간이 없지만 상위 캠페인의 바우처를 사용합니다.
외부 상거래 엔진도 바우처를 제공할 수 있습니다.이를 위해서는 최소 다음 항목이 필요합니다.
isValid()
메서드바우처 구성 요소( /libs/commerce/components/voucher
)는 다음을 제공합니다.
프로모션:
프로모션은 웹 사이트 콘솔에서 생성/편집되고 아래에 저장되는 페이지 기반 구성 요소입니다.
/content/campaigns
프로모션 공급:
프로모션을 캠페인에 연결하여 해당 설정/해제 날짜/시간을 정의할 수 있습니다.
프로모션을 경험에 연결하여 세그먼트를 정의할 수 있습니다.
경험에 연결되어 있지 않은 프로모션은 자체적으로 실행되지 않지만 바우처가 여전히 실행할 수 있습니다.
프로모션 구성 요소( /libs/commerce/components/promotion
)에는 다음이 포함되어 있습니다.
두 개의 프로모션 핸들러가 즉시 제공됩니다.
DiscountPromotionHandler
- 장바구니 전체 절대 또는 백분율 할인을 적용합니다PerfectPartnerPromotionHandler
- 파트너 제품도 장바구니에 있는 경우 제품 절대 또는 백분율 할인을 적용합니다ClientContext SegmentMgr
은 세그먼트를 확인하고 CartMgr
ClientContext이 프로모션을 확인합니다. 하나 이상의 해결된 세그먼트가 적용되는 각 프로모션이 실행됩니다.
카트에서 바우처 추가/제거는 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;
이 방법으로 CommerceSession
은(는) 바우처가 있는지 여부 및 바우처가 적용되는지 여부를 확인합니다. 이는 특정 조건이 충족되는 경우에만 적용할 수 있는 바우처용일 수 있습니다.예를 들어 총 장바구니 가격이 $100보다 큰 경우. 어떤 이유로든 바우처를 적용할 수 없는 경우 addVoucher
메서드에서 예외가 발생합니다. 또한 바우처가 추가/제거된 후 CommerceSession
에서 장바구니의 가격을 업데이트할 책임이 있습니다.
Voucher
은(는) 다음 필드를 포함하는 Bean과 같은 클래스입니다.
제공된 AbstractJcrCommerceSession
은 바우처를 적용할 수 있습니다. 클래스 getVouchers()
에서 반환된 바우처는 다음 속성을 갖는 jcr:content 노드를 포함하는 cq:Page
의 인스턴스입니다.
sling:resourceType
(문자열) - 다음을 수행해야 합니다. commerce/components/voucher
jcr:title
(문자열) - 바우처 설명
code
(문자열) - 이 바우처를 적용하려면 사용자가 입력해야 하는 코드입니다
promotion
(문자열) - 적용할 프로모션예 /content/campaigns/geometrixx-outdoors/article/10-bucks-off
프로모션 처리기는 장바구니를 수정하는 OSGi 서비스입니다. 장바구니는 PromotionHandler
인터페이스에 정의할 몇 개의 후크를 지원합니다.
/**
* 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();
3개의 프로모션 핸들러가 즉시 제공됩니다.
DiscountPromotionHandler
장바구니 전체 절대 또는 백분율 할인 적용PerfectPartnerPromotionHandler
제품 파트너가 장바구니에 있는 경우, 절대 또는 퍼센트 할인을 적용합니다FreeShippingPromotionHandler
무료 배송