> ## 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.

# مرجع واجهة البرمجة

> نقاط نهاية REST وعمليات GraphQL لـ MiniApps.

توفّر ميني أب سطحاً صغيراً من **REST** لـ OAuth والويب هوك الواردة. يتفاعل المستأجرون مع ميني أب المثبّتة عبر **GraphQL** في تطبيق كرزون (تثبيت السوق وبيانات الاعتماد وتنفيذ الإجراءات).

المسار الأساسي: `{SAAS_API_URL}/miniapps`

## نقاط نهاية REST (وقت التشغيل)

| الطريقة | المسار              | الوصف                                    |
| ------- | ------------------- | ---------------------------------------- |
| `GET`   | `/{appNs}/oauth2`   | بدء أو إكمال تفويض OAuth 2.0             |
| `POST`  | `/{appNs}/webhooks` | استقبال الويب هوك من المزوّدين الخارجيين |

سجّل هذه العناوين لدى مزوّدك:

* **Redirect URI:** `{SAAS_API_URL}/miniapps/{ns}/oauth2`
* **Webhook URL:** `{SAAS_API_URL}/miniapps/{ns}/webhooks`

## GraphQL — السوق والتثبيت

متاحة لمستخدمي كرزون المصادق عليهم في التطبيق. انظر [مرجع واجهة GraphQL](/api-reference) لأنواع الوسائط الكاملة.

### الاستعلامات

| الاستعلام                 | الوصف                                                         |
| ------------------------- | ------------------------------------------------------------- |
| `listMiniAppsGeneralInfo` | تصفّح تطبيقات السوق (`installStatus` و`search`)               |
| `miniAppGeneralInfo`      | قائمة تطبيق واحد حسب `ns`                                     |
| `miniAppDetail`           | تفاصيل التطبيق المثبّت — الإجراءات والنماذج (`miniAppNs`)     |
| `miniAppsActionSources`   | بيانات القوائم المنسدلة عبر RPC (`miniAppNs` و`sourceKey` و…) |
| `testMiniApiRequest`      | اختبار طلب إجراء واحد (أدوات المطوّر في التطبيق)              |
| `miniAppDashboardConfig`  | جسر iframe للوحة التحكم — الإجراءات وحالة المصادقة            |

### الطفرات

| الطفرة                   | الوصف                                                                     |
| ------------------------ | ------------------------------------------------------------------------- |
| `installMiniApp`         | التثبيت من السوق (`ns`)                                                   |
| `saveMiniAppCredentials` | حفظ بيانات اعتماد المصادقة؛ يشغّل تبادل الرمز + التسجيل                   |
| `executeMiniAppAction`   | تشغيل إجراء ببيانات اعتماد من الخادم (`appNs` و`actionName` و`formInput`) |

<Warning>
  **حدود المعدل** — تنفيذ الإجراءات محدود بالمعدل لكل مستخدم لكل تطبيق (30 طلباً / 60 ثانية). صمّم الإجراءات لتكون idempotent حيثما أمكن.
</Warning>

## ويب هوك المستأجر مقابل ويب هوك ميني أب

|             | [ويب هوك المستأجر](/ar/developers/guides/webhooks) | ويب هوك ميني أب                           |
| ----------- | -------------------------------------------------- | ----------------------------------------- |
| **الاتجاه** | كرزون → خادمك                                      | المزوّد → كرزون                           |
| **الغرض**   | إشعار خلفيتك بأحداث مساحة العمل                    | استيعاب أحداث المزوّد في الأتمتة/المزامنة |
| **التسجيل** | `webhooksAdd` GraphQL                              | معرّف في JSON لميني أب + لوحة المزوّد     |


## Related topics

- [MiniApps](/ar/miniapps/index.md)
- [العلامة البيضاء](/ar/partners/whitelabel.md)
- [إعداد الشريك](/ar/partners/onboarding.md)
- [كتالوج أدوات MCP](/ar/mcp-server/tools/catalog.md)
- [سجل التغييرات](/ar/changelog.md)