1. Introduction
Sanal AI
  • Introduction
    • ๐Ÿ’ฌ Sanal AI Integration
    • ๐Ÿค Overview
    • ๐Ÿš€ Getting Started
    • ๐Ÿ› ๏ธ Integration Flow
    • โœ… Checklist
    • ๐Ÿ”Œ Bridge Protocol
  • Data Sync
    • ๐Ÿ› ๏ธ Data Sync
    • ๐Ÿ“ Data Layout
    • ๐Ÿช Merchants
    • ๐Ÿ“‚ Categories
    • ๐Ÿท๏ธ Items
    • ๐Ÿ›’ Products
    • ๐Ÿ“ฆ Inventory
    • ๐Ÿ‘ค Customers
    • ๐Ÿงพ Orders
    • ๐Ÿงพ Variants & Combinations
  • API Requirements
    • ๐Ÿ”Œ API Requirements
    • API: `syncMerchants`
    • API: `syncCategories`
    • API: `syncItems`
    • API: `syncProducts`
    • API: `syncInventory`
    • API: `syncCustomers`
    • API: `syncOrders`
  1. Introduction

๐Ÿš€ Getting Started

๐Ÿ” Before you begin#

Your app must already have:
1.
Authenticated with the Sanal platform and hold a valid user ID and auth token (JWT or session token) to use for embedding Chat AI widget.
2.
Products Listing โ€” items, quantities, variants, and the active merchant ID, these are standard features in your app.
3.
App navigation โ€” checkout, product detail, merchant detail, and delivery addresses.
The widget does not show a login screen. It uses the credentials you send after load.

๐Ÿ”— Sanal AI Widget URL#

Use the URL provided to integrate with widget in your environment:
https://widget.sanal.ai/widget?mode=embedded&lang=en
Query paramValuesDescription
modeembeddedEmbedded / host-app mode
langen, arUI language

๐Ÿ”„ How to embed our Widget#

You can load our widget using the URL in:
1.
A WebView for Flutter, React Native or
2.
An iframe for Web
See the Integration Flow on more details after the widget loads.
Previous
๐Ÿค Overview
Next
๐Ÿ› ๏ธ Integration Flow
Built with