1. Embedded SDK
Salla Platform Docs
  • Embedded SDK
    • Overview
    • Getting Started
    • Create an Embedded App
    • Authentication
    • App Design Guidelines
    • Installation
    • Playground
  • Auth Module
    • Get Token
    • Client Introspect
    • Refresh Token
  • Page Module
    • External Redirects
    • Navigation
    • Set Page Title
  • Nav Module
    • Create Navbar Action
    • Listen for Navbar Actions
    • Clearing Navbar Actions
    • Add Navbar Item
    • Update Navbar Item
    • Listen for Navbar Item Click
    • Remove Navbar Item
  • UI Module
    • Confirm Dialogs
    • Toast Notifications
    • Loading States
    • Breadcrumbs
  • Checkout Module
    • Create Checkout
    • Get App Add-ons
    • Subscribe for Payment Result
  • Endpoints
    • Token Introspect
      POST
  • Resources
    • Support
    • Common Examples
  • Report Builder
    • Overview
    • Getting Started
    • JMESPath Tutorial
    • Understanding the Report Lifecycle
    • Salla Reports Examples
    • Set up Store data using merchant APIs
    • Report Types
      • Unit
      • Bar
      • Breakdown
      • Calendar
      • Distribution
      • Pipe
      • Plot
      • Ranking
      • Summary
      • Agrid
    • APIs
      • Token Introspect
  • App Onboarding
    • Overview
    • Get Started
    • Interfaces and Responses
    • Example
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Merchant
Merchant
  • Merchant API
  • Embedded SDK
  • Salla OAuth 2.0
Storefront
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Ecommerce Events
  • Component Bundle
  • Checkout APIs
  • Change Log
App Functions
Partner APIs
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Salla AWB
  • Recurring Payments API
  • Billing System Salla partners
  • Communication Apps
Dev Tools
Dev Tools
  • Partners Agent Kit
  • Salla Apps Playbook
  • Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Embedded SDK

Welcome to Salla Embedded 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.
Embedded App Preview
This documentation is written for third-party developers to help build seamless, integrated applications that live directly within the Salla Merchant Dashboard.

Documentation Structure#

OverviewIntroduction to the SDK, its purpose, and core architecture.
Getting StartedFollow quick start guide to set up your app, configure embedded pages, align UI with the dashboard.
Create an embedded appHow to register your app and add embedded pages in Salla Partners.
InstallationGet up and running using NPM or a CDN.
AuthenticationDetailed guide on token management and app security.
App Design GuidelinesDesign requirements and brand alignment for a native Salla experience.
Playground TestingUsing the Playground and Test Kit to prototype SDK functions.
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.
Checkout Module
Create Checkout, Get App Add-Ons and Subscribe for Payment.
EndpointsToken Introspect
Resources Support & Contribution
Community links and open-source contribution guidelines.

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.

#

Modified at 2026-05-12 12:03:04
Next
Getting Started