> ## Documentation Index
> Fetch the complete documentation index at: https://docs.karzoun.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard SDK

> ابنِ تطبيقات لوحات صندوق الوارد باستخدام Karzoun Dashboard SDK.

`@karzoun/dashboard-sdk` — SDK خفيف لتطبيقات **لوحة التحكم** داخل iframe صندوق وارد كرزون.

## التثبيت

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
npm install @karzoun/dashboard-sdk
```

## بداية سريعة

```typescript theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { createDashboard } from "@karzoun/dashboard-sdk";

const dashboard = createDashboard({
  miniappId: "YOUR_MINIAPP_ID",
});

dashboard.onContext((ctx) => {
  console.log("Customer:", ctx.customer);
});

await dashboard.executeAction("listOrders", { limit: 10 });
```

## المتطلبات الأساسية

1. ثبّت واضبط **MiniApp** ببيانات اعتماد صالحة (الإعدادات ← MiniApps)
2. أنشئ **تطبيق لوحة تحكم** يشير إلى عنوان iframe المستضاف لديك (الإعدادات ← تطبيقات لوحة التحكم)

## الميزات

* استقبال سياق المحادثة والعميل من المضيف
* تنفيذ إجراءات مصادق عليها عبر MiniApp (لا تُعرَض بيانات الاعتماد أبداً داخل iframe)
* تشغيل واجهة المضيف: إشعارات toast، وملاحظات، ووسوم، وتنقّل

راجع README الحزمة تحت `v4UI/dashboard-sdk` في مستودع كرزون الأحادي لمرجع API وبروتوكول postMessage والأمثلة.


## Related topics

- [SDK](/ar/sdk/index.md)
- [MiniApps](/ar/miniapps/index.md)
- [نظرة عامة](/ar/developers/index.md)
- [Karzoun Pixel](/ar/sdk/pixel.md)
- [conversationCounts](/api-reference/queries/conversationCounts.md)