1. Scayle Resource Center
  2. Onboarding Guide
  3. Onboarding: Backend
  4. Introduction

Introduction

Welcome to your SCAYLE technical onboarding. This tutorial will guide you through the basic backend configurations and integrations you’ll need to start your eCommerce business with the SCAYLE commerce engine. We’ll help you understand the basic concepts and terminology, show you how to configure your online store, and use the Admin API.

Want to better understand the frontend of your SCAYLE business? We’ve got you covered right here.

You don’t have to be a SCAYLE expert to understand this guide, but a basic understanding of eCommerce and simple API requests will be helpful.

For the sake of this tutorial, we assume that you have access to the SCAYLE Panel and relevant URLs. Please get in touch with your contact person at SCAYLE if you need access.

SCAYLE Panel

The SCAYLE Panel is the user interface you’ll use to administer and manage shops and product data. We’ll apply several configurations via the Panel throughout this guide.

For more information, see the User Manual.

Admin API

The Admin API is a REST API you can use to access your data.

Here are the typical ways you can use Admin API:

  • Create and administer various shops
  • Manage product data such as categories, variants, images, prices, and price campaigns
  • Handle inventory and warehouses
  • Manage translations and localization for different shops

The Admin API also enables you to subscribe to webhooks which will keep you up to date about events happening in SCAYLE, such as new orders.

To access Admin API, you’ll need to generate an authentication token via the Panel. Here’s how:

Create API Token via the Panel

  1. Sign in to your SCAYLE Panel.
  2. Navigate to Settings > General > API Keys.
  3. Choose API Keys.
  4. In the section Shop External add a new token.
  5. Copy the token.

For further information, see API Keys.

Authenticate to the API

Your token is similar to a password, so don’t forget it or share it with anyone.

You can use the generated token within the X-Access-Token section to authenticate to the Admin API.

For more details, see API Authentication.

SDK

The SCAYLE Admin API offers official libraries for different programming languages. As the Admin API only concerns backend services, we only provide server-side libraries.
For more information, see SDK Setup.

For productive integrations with SCAYLE, we strongly recommend using the SDKs. However, within this guide, we will use the endpoints directly without the SDK.

We recommend using a tool like Postman to follow this tutorial.