Overview

Welcome to the Embedded App SDK documentation for third-party developers. This guide will help you build seamless, integrated applications that live directly within the Salla Merchant Dashboard.

What is the Embedded App SDK?

The Salla Embedded SDK is a powerful communication bridge that allows your third-party application (running in an iframe) to interact securely with the Salla Merchant Dashboard. It provides a set of helper methods to sync themes, handle navigation, trigger UI components, and manage authentication—ensuring your app feels like a native part of the Salla platform.

📚 Documentation Structure

1. Getting Started

📖 Overview — Introduction to the SDK, its purpose, and core architecture.

🏗️ Create an embedded app — How to register your app and add embedded pages in Salla Partners.

🚀 Installation — Get up and running using NPM or a CDN.

🔐 Authentication — Detailed guide on token management and app security.

🎨 App Design Guidelines — Design requirements and brand alignment for a native Salla experience.

🧪 Playground Testing — Using the Playground and Test Kit to prototype SDK functions.

2. SDK Modules Reference

Detailed guides for every SDK method, organized by module:

🔐 Auth Module — Token management and app security.

📄 Page Module — Managing document titles, navigation, and iframe resizing.

🧭 Nav Module — Customizing the dashboard navbar and action buttons.

🎨 UI Module — Guides for Toasts, Modals, Confirm dialogs, and Loading states.

3. Resources

💬 Support & Contribution — Community links and open-source contribution guidelines.

Key Concepts

The Bootstrap Handshake

Every embedded app must follow a standard 3-step handshake to establish a secure connection:

Initialization

The app calls init() to receive dashboard context like theme, locale, and currency.

Verification

The app retrieves the session token via auth.getToken() and verifies it with its backend.

Signaling Ready

Once verified and loaded, the app calls ready() to remove the dashboard loading overlay.

Next Steps

Install the SDK

Add the SDK to your project via NPM or CDN to initialize your app.

Create Your First App

Configure your embedded pages in the Salla Partner Portal.

Setup Authentication

Securely verify session tokens using the Salla Introspection API.

Prototype in Playground

Use the interactive playground to develop and test your integration logic in real-time.

What is the Embedded App SDK?#

📚 Documentation Structure#

1. Getting Started#

2. SDK Modules Reference#

3. Resources#

Key Concepts#

The Bootstrap Handshake#

Next Steps#