We have migrated to a new XAPI architecture to better support the evolving needs of our business API with GraphQL. The VirtoCommerce.ExperienceApi module has been replaced with a suite of new, more specialized modules. This change is part of our effort to simplify business API development and streamline our release cycle.
Please transition from the legacy VirtoCommerce.ExperienceApi module to the new modules listed below:
- VirtoCommerce.Xapi: Core business API module.
- VirtoCommerce.XCart: Handles cart-related functionalities.
- VirtoCommerce.XCatalog: Manages catalog-related operations.
- VirtoCommerce.XCMS: Content management system integration.
- VirtoCommerce.XOrder: Manages order processing.
Please refer to the following update path instructions for more detailed guidance on updating the new modules.
- GraphQL Schema Compatibility: All GraphQL schemas remain compatible, so no frontend modifications are required directly due to schema changes. (Note: deprecated mutation
valdateCouponwas removed. UsevalidateCouponquery instead). - API Endpoint Changes: If your frontend directly calls endpoints provided by VirtoCommerce.ExperienceApi, verify and update the endpoint URLs to match the new module structure if necessary.
- Testing: Thoroughly test frontend interactions to ensure smooth functionality with the new backend modules.
- Dependency Changes: Custom modules that depended on VirtoCommerce.ExperienceApi will need to be updated to depend on the appropriate new modules (VirtoCommerce.Xapi, VirtoCommerce.XCart, VirtoCommerce.XCatalog, VirtoCommerce.XCMS, VirtoCommerce.XOrder).
- Uninstall Old Packages: Ensure to uninstall the NuGet packages from VirtoCommerce.ExperienceApi and replace them with the new packages. Code Adjustments: Review and adjust your code to align with the new module structures and namespaces.
To transition to the new modules, follow these steps:
- Uninstall VirtoCommerce.ExperienceApi.
- Install the new modules:
- VirtoCommerce.Xapi
- VirtoCommerce.XCart
- VirtoCommerce.XCatalog
- VirtoCommerce.XCMS
- VirtoCommerce.XOrder
- Update other modules to the new version if required, ensuring they now depend on VirtoCommerce.Xapi:
- VirtoCommerce.MarketingExperienceApi
- VirtoCommerce.Quote
- VirtoCommerce.CustomerReviews
- VirtoCommerce.Skyflow
- VirtoCommerce.TaskManagement
- VirtoCommerce.FileExperienceApi
- VirtoCommerce.WhiteLabeling
- For any custom modules, uninstall the NuGet packages from VirtoCommerce.ExperienceApi and replace them with the new ones.
- Models, service interfaces, GraphQL schema types and input types, commands, queries and aggregates are moved to respective Core projects of the new modules (XCatalog.Core. XCart.Core, etc) with namespaces adjusted. Data projects contain service implementations, command and query builders, command and query handlers, and middleware.
- Schema: validateCoupon command (was marked as Deprecated) was removed, use validateCoupon query.
VirtoCommerce.ExperienceApi is archived and will be supported in Stable 8 and Stable 9 releases. Future developments will focus on the new VirtoCommerce.Xapi and related modules. The latest Edge release has adopted the new modules.
The project "Experience API" it is primarily a intermediated layer between clients and enterprise services powered by GraphQL protocol and is tightly coupled to a specific user/touchpoint experience with fast and reliable access, it represents an implementation of Backend for Frontend design pattern (BFF).
The context diagram:
- Use GraphQL protocol to leverage more selective and flexible control of resulting data retrieving from API;
- Fast and reliable indexed search thanks to integration with ES 7.x and single data source for indexed search and data storage (<= 300ms);
- Autonomy. Shared nothing with rest VC data infrastructure except index data source;
- Tracing and performance requests metrics.
- X-Catalog docs
- X-Purchase cart docs
- X-Purchase order docs
- X-UserProfile module (moved to a separate module)
- Recommendations Gateway API (prototype)
To explore the GraphQL API, you can use an interactive graphql-playground environment.
To open playground console open ui/playground in the platform manager application.
http://localhost:10645/ui/playground
POST https://{platform-url}/graphql
It accepts POST requests with following fields in a JSON body:
query- String - GraphQL query as a stringvariables- Object - Optional - containing JSON object that defines variables for your queryoperationName- String - Optional - the name of the operation, in case you defined several of them in the query
Here is an example of a GraphQL query:
$ curl -X POST http://localhost:10645/graphql \
-H "Content-Type:application/json" \
-H "Authorization:Bearer ..." \
-d '{"operationName":null,"variables":{},"query":"{ product(id: \"019e93d973cd4adab99b6f9cbb4ca97a\") { name }}"}'
Read this article...
Read this article...
Read this article...
The project has integration with Elastic Search 7.x and Azure Search Service providers for indexing search.
Lucene search provider not supported.
Experience API Module Document
- Deploy: https://virtocommerce.com/docs/latest/developer-guide/deploy-module-from-source-code/
- Installation:https://www.virtocommerce.com/docs/latest/user-guide/modules/
- Home: https://virtocommerce.com
- Community: https://www.virtocommerce.org
- Download Latest Release
Copyright (c) Virto Solutions LTD. All rights reserved.
Licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://virtocommerce.com/opensourcelicense
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.