✨Twilight comes with a JavaScript SDK for the Salla storefront APIs. This is to provide the developers with helper methods, or REST API endpoints, that allow communication between the frontend and backend. As a result, developers may use these methods to make merchants' stores dynamic after using the API features and data. In this documentation, we will be referring to it as Twilight JS SDK for short.SDK stands for "software development kit," and it refers to a library for interacting with a specific REST API using JavaScript.
📙 What you'll learn#
SDK's main APIs#
The main parts of the Twilight JS SDK includes REST API endpoints that ease the actions related to the APIs request, such as:
Authorization APIs
Several endpoints for customer logging in, logging out, and many more
Cart APIs
Customer's cart list of endpoints.
Comments APIs
Group of endpoints related to the customer comments, or feedback, on product or page.
Currency APIs
Group of endpoints related to the store's currencies list
Order APIs
Customer's orders related endpoints.
Product APIs
Product related endpoints.
Profile APIs
Customer's profile endpoints.
Rating APIs
endpoints related to the store, product, order, shipping rating.
Wishlist APIs
Customer's wishlist endpoints.
Loyalty APIs
Customer's loyalty endpoints.
Booking APIs
Book product or service endpoints.Use cases#
Following are some of the possible uses of the Twilight JS SDK: |
|---|
| Authenticating customers and allowing them to edit account details. |
| Adding a product directly from the products list to the customer art. |
| Returning the price of a product. |
| Adding a product to the customer's wishlist. |
| Rating the shipping company responsible for delivering orders, and many more. |
Installation#
Twilight JS SDK can be used without the need to be downloaded or installed; instead it needs to be included as a short piece of regular JavaScript in the HTML that will asynchronously load the SDK into the Twilight theme. In case of using the
Twilight JS SDK inside the Twilight themes, the developer doesn't need to include the
Twilight JS SDK in the theme project's bundle or inside the html,
Twilight theme engine will inject the latest version of the
Twilight JS SDK in the page.
Basically, the developer does not need to call the method salla.init() for twilight themes, because it will be called automatically upon the installation of the Twilight theme engine. This is done thanks to the body:end hook {% hook 'body:end' %}. Usage#
As a result of the SDK initialization, the developer will be able to use any of the SDK's main APIs. For example, the method addItem adds an item into the cart, the developer may call the method addItem as follows:In addition to the above example, the method addItem may add an item with multiple options to the carts as follows:Furthermore, a large number of store events will be available for use. Thus, the developer's Theme may be configured to respond automatically to a variety of activities, such as:The user requested an Access Code to perform a login, however, the code was not sent. For this scenario, using the method salla.event.auth.onCodeNotSent((error, type) => console.log(error, type)) can be used.
A new item has been added to the cart via the salla.cart.event.onItemAdded((response, product_id) => console.log(response, product_id)) method.
The user added a new item to the Wishlist using the method salla.event.wishlist.onAdded((response, product_id) => console.log(response, product_id)).
onItemAdded which is triggered when adding an item to the cart is done without having any errors coming back from the backend:On the other hand, the event onItemAddedFailed is triggered when adding an item to the cart is not completed and an error has occurred. For example, the id of the product to be added to the cart was not found.Basic configuration#
Aside from calling the APIs, the developer has the ability to configure the Twilight engine to meet the needs of his theme.This list of the available configurations can be found in this
article.
salla.config.get() is used to retrieve a configuration value, while salla.config.set() is used to set a configuration value.Set configuration value#
The developer may set the debug mode to be activated. That is to state, the theme will be run in a debugger. This means that the debugger keeps track of everything that happens while the theme is running.Get configuration value#
Similarly, the developer can use the method salla.config.get() to get any value from the configuration file. To retrive simaple value such as the user Id, the following syntax can be followed:Furthermore, if the required value is nested inside an inner value, such as a currency code, the following syntax can be followed: 
