آغاز کرنا

Integration overview

ایک بیک اینڈ، ہر پلیٹ فارم۔ ایک بار ایمبیڈ کریں، اور یہ ہمیشہ اپ ٹو ڈیٹ رہتا ہے۔

AskAIs ایک ہی بیک اینڈ ہے جس کے ساتھ جُڑنے کے کئی طریقے ہیں۔ آپ اپنا ورک اسپیس ایک بار سیٹ اپ کرتے ہیں، پھر چیٹ کو کہیں بھی ایمبیڈ کر سکتے ہیں، کسی ویب سائٹ، موبائل ایپ، یا کسی بھی بیک اینڈ سروس میں۔ آپ کے گاہک Telegram اور WhatsApp جیسے اِن باؤنڈ چینلز کے ذریعے بھی آپ سے رابطہ کر سکتے ہیں۔ ہر کلائنٹ اور ہر چینل اسی ایک inbox، AI ایجنٹ، اور نالج بیس سے بات کرتا ہے۔

ایک بیک اینڈ، ہر پلیٹ فارم

آپ جو بھی پلیٹ فارم استعمال کریں، انسٹال مختصر ہوتا ہے اور گفتگو، کانٹیکٹ، AI جوابات، اور سیٹنگز سب کے درمیان مشترک رہتی ہیں۔ یہاں دیکھیں کہ ہر پلیٹ فارم کیسے انسٹال ہوتا ہے اور، جو اہم بات ہے، مستقبل کے اپڈیٹس اسے کیسے ملتے ہیں:

پلیٹ فارمز ایک نظر میں

پلیٹ فارم	انسٹال	یہ کیسے اپڈیٹ ہوتا ہے
ویب سائٹ	`<script src="…/widget.js">`	خودکار، ہر صفحہ لوڈ ہونے پر تازہ ترین حاصل ہوتا ہے
iOS (WebView)	`WebView embed`	خودکار، WebView تازہ ترین ویجٹ لوڈ کرتا ہے
Android (WebView)	`WebView embed`	خودکار، WebView تازہ ترین ویجٹ لوڈ کرتا ہے
Flutter (نیٹِو SDK)	`pub (local package)`	SDK ورژن بڑھائیں، نیا ایپ بِلڈ شِپ کریں
React Native (WebView)	`WebView / REST`	خودکار، WebView تازہ ترین ویجٹ لوڈ کرتا ہے
کوئی بھی بیک اینڈ	`REST API / OpenAPI`	آپ کی اپنی سروس، جب بھی آپ ڈیپلائے کریں

کیا تمام کلائنٹس اور چینلز مل کر کام کرتے ہیں؟

جی ہاں۔ یہ ایک ہی AskAIs ورک اسپیس کے مختلف دروازے ہیں، اس لیے یہ مکمل طور پر باہم قابلِ عمل ہیں:

ایک ہی بیک اینڈ، ایک ہی app-id: ہر کلائنٹ آپ کے ورک اسپیس کے اسی inbox سے جُڑتا ہے۔
متعدد ڈیوائسز پر ایک ہی وزیٹر: انہیں اسی externalId سے شناخت کریں، اور ویب پر شروع ہونے والی چیٹ آپ کی ایپ میں جاری رہتی ہے۔
صرف ایمبیڈ ہی نہیں، اِن باؤنڈ چینلز بھی: ویب اور ایپ کے اندر موجود ویجٹ کے علاوہ، آپ کے گاہک Telegram اور WhatsApp پر بھی آپ سے رابطہ کر سکتے ہیں (دونوں اینڈ ٹو اینڈ چل رہے ہیں)، اور ہر پیغام اسی ایک inbox میں پہنچتا ہے، اور X کے لیے جگہ بھی تیار ہے۔
مشترکہ کنفیگریشن: آپ کا AI ایجنٹ (پلیٹ فارم پر میزبان یا آپ کی اپنی کی)، نالج بیس، کاروباری اوقات، کی ورڈ جوابات اور FAQs ایک بار کنفیگر کیے جاتے ہیں اور ہر چینل پر لاگو ہوتے ہیں۔

ویب، آفیشل ایمبیڈ (تجویز کردہ)

یہ ایک لائن </body> سے پہلے رکھ دیں۔ بس یہی پورا انسٹالیشن ہے۔ app-id عوامی ہے اور شِپ کرنے کے لیے محفوظ ہے؛ اسے Settings → Inboxes سے کاپی کریں۔

<script src="https://singchat.org/widget.js"
        data-app-id="YOUR_APP_ID"
        data-base-url="https://singchat.org"
        async></script>

⚠️ widget.js کو ڈاؤن لوڈ یا سیلف ہوسٹ نہ کریں
ویجٹ کو ہمیشہ https://singchat.org/widget.js سے لوڈ کریں۔ اگر آپ فائل ڈاؤن لوڈ کر کے خود ہوسٹ کرتے ہیں، یا اسے اپنے بنڈل میں کمپائل کر لیتے ہیں، تو آپ اسے ایک ہی ورژن پر منجمد کر دیتے ہیں، ہمارے مستقبل کے اسٹائل اپڈیٹس، بگ فکسز اور نئی خصوصیات کبھی آپ تک نہیں پہنچیں گی۔ singchat.org سے لوڈ ہونے پر، ویجٹ خود بخود اپڈیٹ ہوتا رہتا ہے؛ آپ کو کچھ تبدیل نہیں کرنا پڑتا۔

اسے اپنے صفحے سے کنٹرول کریں (اختیاری)

اسکرپٹ لوڈ ہونے کے بعد، ایک گلوبل window.SingChat دستیاب ہوتا ہے:

// Open / close the widget
window.SingChat.open();
window.SingChat.close();

// Identify a logged-in user (so chats follow them across devices)
window.SingChat.identify({ externalId: "user_123", name: "Ada", email: "ada@acme.com" });

موبائل ایپس: Flutter SDK یا WebView ایمبیڈ

موبائل کے لیے آپ کے پاس تین حقیقی طریقے ہیں۔ پہلا، نیٹِو Flutter ویجٹ SDK ایک مکمل، تھیم کے قابل چیٹ UI دیتا ہے (فلوٹنگ ببل اور نیٹِو چیٹ اسکرین، WebView نہیں)؛ اسے اپنے pubspec میں شامل کریں اور شِپ کر دیں۔ دوسرا، iOS اور Android (اور React Native) پر آپ پورے ویب ویجٹ کو WebView کے اندر ایمبیڈ کر سکتے ہیں، ویب سائٹ جیسا ہی تجربہ، اور یہ خود بخود اپ ٹو ڈیٹ رہتا ہے۔ تیسرا، REST API کو دستخط شدہ webhooks کے ساتھ چلائیں اور اپنا UI خود رینڈر کریں۔ انسٹال کرنے کے لیے iOS، Android یا React Native کا کوئی الگ نیٹِو چیٹ SDK نہیں ہے؛ یہی معاون طریقے ہیں۔

# Flutter, native chat widget (floating bubble + native chat UI, not a WebView).
# In your app's pubspec.yaml (download and unzip the SDK package first):
dependencies:
  singchat_widget:
    path: ../singchat_widget

# iOS / Android / React Native without Flutter: load the hosted web widget in a
# WKWebView / WebView (same experience as the website), or drive the REST API
# with signed webhooks and render your own chat UI.

کوئی بھی بیک اینڈ یا زبان

کسی SDK کی ضرورت نہیں، کسی کانٹیکٹ کی شناخت کرنے اور پیغامات بھیجنے/وصول کرنے کے لیے براہِ راست REST API کال کریں، اور اِن باؤنڈ ایونٹس کی تصدیق دستخط شدہ webhooks سے کریں۔ پورا API ایک شائع شدہ OpenAPI اسپیسیفکیشن کی پیروی کرتا ہے، اس لیے آپ اپنی زبان میں کلائنٹ جنریٹ کر سکتے ہیں یا اینڈ پوائنٹس کو براہِ راست کال کر سکتے ہیں۔

# Any backend / language, talk to the REST API directly
curl -X POST https://singchat.org/api/v1/auth/identify \
  -H 'Content-Type: application/json' \
  -d '{"appId":"YOUR_APP_ID","externalId":"user_123"}'

مزید گہرائی میں جائیں

پچھلافوری آغاز اگلاMCP server (AI agents)