docs
  1. Scayle Resource Center
  2. Getting started
  3. Quick Start
  4. Welcome

Welcome

General

Welcome to your getting started guide for SCAYLE. By the end of this tutorial, you'll have set up a simple shop in your local environment, complete with a few basic product listings.

Note that this guide aims for speed and clarity, intentionally omitting some details for the sake of brevity. It's meant to quickly give you a taste of how to work with the product, and understand how the different aspects of SCAYLE (APIs, Panel, and Storefront) relate to each other. For a more in-depth introduction to all the capabilities of SCAYLE , refer to our Onboarding Guide.

In addition to setting up the shop, this tutorial will also cover:

  • How to use the key SCAYLE APIs
  • Importing and managing product data
  • Handling shop categories and attributes
  • How to customize the Storefront Boilerplate to meet your specific requirements, demonstrated through a small example

Here's what we'll be setting up: A fully functional fashion shop. In the next section, we'll cover the prerequisites you'll need to continue with this tutorial.

Fashion Shop Example

Tutorial Content

SectionSummary
Importing Product DataLearn how to add shop data either by using demo data (Option 1) or Admin API (Option 2) to the backend.

Option 2 requires more steps to go through and includes testing your connection, adding a shop, creating Attribute Groups, Master Categories, Warehouse, Importing your products and creating shop categories. This option requires more time/effort but you'll learn how the data is handled in SCAYLE. You can use this scenario for your actual shop set up.
Query your product dataUse Storefront API SDK (JavaScript) to link the data added in the previous section to the shop frontend.
Enhance your storefrontUse our starter kit to customize your shop frontend

You may also find it interesting to visit our comprehensive course available on the SCAYLE Academy platform.

SCAYLE Infrastructure

What is SCAYLE?

SCAYLE is a full-featured e-commerce software solution that comes with flexible APIs. Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.

SCAYLE offers two core APIs, the Admin API and the Storefront API, that are used to create and manage data within a shop. In addition, SCAYLE offers the Storefront Boilerplate, a highly-customizable template that makes it easy to build a frontend for shops.

Admin API

The Admin API is a JSON REST API used interact with customer and transaction data and import products and stocks. You'll use this API to manage all of your shop data.

Typical use cases for the Admin API include:

  • Managing product data, such as categories, variants, images, prices, and price campaigns.
  • Handling inventory and warehouses.
  • Managing translations and localization for different shops.
  • Creating and administering different shops.

Storefront API

The Storefront API is a REST API used to access your product data in any customer-facing application. It's extremely scalable and optimized for fast responses and high load. You'll use this API to construct your online shop.

Typical use cases for the Storefront API include:

  • Displaying shop navigation.
  • Rendering product listing page and filter.
  • Displaying a product detail page.
  • Adding products to your basket & wishlist.
  • Searching for products.
  • Displaying shop navigation.
  • Rendering product listing page and filter.
  • Displaying a product detail page.
  • Adding products to your basket & wishlist.
  • Searching for products.

Storefront Boilerplate

The Storefront Boilerplate is an all-in-one starter kit for building high-performance shops for the SCAYLE Commerce Engine. A key advantage from using the Storefront is that the effort for creating a new shop is drastically reduced, as it frees you up to focus on the design details of your front-end.

Storefront Boilerplate includes:

  • Product listings and product detail pages
  • Category tree navigation and filtering
  • Wishlist and basket functionality
  • A complete checkout integration
  • Best-of-class user tracking
  • Internationalization
  • Integration with a headless CMS for managing content

For more detailed information about Storefront Boilerplate and its capabilities, refer to our Storefront Guide.

SCAYLE Panel

Use the Panel to:

  • manage your shop via user interface
  • get your API keys
  • get your Shop ID