Introduction to Kibo eCommerce
Click on the different Kibo eCommerce components to learn more about them.
The Kibo eCommerce REST API is the primary interface that connects the pieces of the Kibo eCommerce platform together, and the primary tool that allows developers to build custom Kibo eCommerce applications. The API provides a multitude of resources, such as the Customer resource or the Orders resource, that give you access to nearly every aspect of the Kibo eCommerce experience. Each resource contains unique operations, such as the GetCart or UpdateCart operations, that let you manipulate Kibo eCommerce objects.To learn about all the resources and operations the API offers, refer to the REST API Reference.To learn how to get started building applications with the Kibo eCommerce API, such as authenticating and making requests with the Kibo eCommerce API, refer to the Application Development Requirements.To learn about the SDKs available to make application development easier, refer to the SDK documentation.To learn about the filters you can use to fine-tune your API requests, refer to the Sorting and Filtering topic.
Dev Center is the web portal where developers manage Kibo eCommerce assets, such as the applications and themes installed on specific sandboxes or tenants.
Within Dev Center, you can:
- Manage application packages and versions, install them to sandboxes, add behaviors (permissions the application can perform), assign events to listen to, view application assets, and more.
- Manage theme packages and versions, install them to sandboxes, view theme assets, and more.
- View, edit, create, or delete production sandboxes and tenants.
- View system and application logs.
- Manage Dev Center users.
Admin is the web portal where you configure your Kibo eCommerce site using Site Builder, manage general settings, publish content, and perform day-to-day ecommerce tasks, such as processing orders or applying store credit to customer accounts.To log in to Admin, log in to Dev Center and click View Sandbox on the sandbox you want to view. If you don't have access to Dev Center, ask your Dev Center administrator for your Admin login link.To learn how to configure your site and perform day-to-day ecommerce tasks, view the Guides documentation set. To view this content, you will be asked to log in to your account.
The storefront application is the web application that runs your site. As shoppers interact with your site, the storefront application:
- Interfaces with your theme files to render your site.
- Interfaces with the Kibo eCommerce API to provide data for your site.
- Executes default and custom Kibo eCommerce routes.
- Processes resources, such as images and stylesheets, for use on your site.
- Processes query strings for debugging and other advanced use cases.
Kibo eCommerce applications, whether provided by Kibo eCommerce, created by you, or sold by a third-party, make up a collection of diverse solutions that leverage the Kibo eCommerce API to add to or enhance the power of the Kibo eCommerce platform. The broad stripes of Kibo eCommerce applications include:
- Kibo eCommerce Marketplace—The Marketplace provides free and paid applications that extend the power of Kibo eCommerce by integrating with third-party services, such as fraud detection services, review platforms, third-party payment providers, email marketing systems, and more. You can view documentation for these applications by clicking here.
- Kibo eCommerce Import-Export Application—The Import-Export application is the primary tool for transfering data such as catalogs, customers, and orders to and from your Kibo eCommerce tenant. This application is perfect for migrating data to your first Kibo eCommerce storefront or batch updating existing data.
- Custom Applications—Kibo eCommerce allows you to create your own applications so that you can extend the functionality of Kibo eCommerce to meet your exact use case.
Themes allow you to completely customize the frontend experience of your Kibo eCommerce storefront, enabling you to design beautiful storefronts.
Some of the main components of themes include:
- Hypr Templates—The Hypr templating system specifies how to organize, display, and reuse content within your web pages.
- Hypr Tags and Filters—Hypr provides tags and filters that allow you to add dynamic functionality on top of static templates and to process and transform values.
- Widgets—Widgets allow Site Builder users to drag and drop different pieces of functionality onto a particular web page on your site.
Arc.js is made up of actions that correspond to Kibo eCommerce operations or microservices. Each action runs a function that you program in Node.js to achieve your custom functionality. There are two types of Arc.js actions:
- HTTP Actions—These actions occur before and after an API operation executes, and you can use them to modify the request or response associated with the operation. HTTP actions also include storefront HTTP actions, which run before or after a shopper requests a specific page on your storefront.
- Embedded Actions—These actions are embedded in Kibo eCommerce microservice operations. They might, for example, provide you access to the microservice that manages orders, or the microservice that manages carts. In addition to providing read access to the microservice object, these actions provide special methods that allow you to manipulate the microservice object in predetermined ways.