RPC and API
تكاملات Gateway للتطبيقات الخارجية
يجب أن تتحدث التطبيقات الخارجية مع OpenClaw عبر بروتوكول Gateway اليوم. استخدم Gateway WebSocket وطرق RPC عندما يريد سكربت، أو لوحة معلومات، أو مهمة CI، أو إضافة IDE، أو عملية أخرى بدء تشغيلات الوكيل، أو بث الأحداث، أو انتظار النتائج، أو إلغاء العمل، أو فحص موارد Gateway.
ما المتاح اليوم
| السطح | الحالة | استخدمه من أجل |
|---|---|---|
| بروتوكول Gateway | جاهز | نقل WebSocket، ومصافحة الاتصال، ونطاقات المصادقة، وإصدارات البروتوكول، والأحداث. |
| مرجع Gateway RPC | جاهز | طرق Gateway الحالية للوكلاء، والجلسات، والمهام، والنماذج، والأدوات، والمخرجات، والموافقات. |
openclaw agent |
جاهز | تكامل السكربتات لمرة واحدة عندما يكون التشغيل عبر CLI كافيا. |
openclaw message |
جاهز | إرسال الرسائل أو إجراءات القنوات من السكربتات. |
تحتوي شجرة المصدر على عمل حزم داخلي لمكتبة عميل مستقبلية، لكن هذا ليس سطح تثبيت عاما. تعامل معه كتفصيل تنفيذ معاينة إلى أن تُنشر الحزم وتُمنح إصدارات.
المسار الموصى به
- شغّل Gateway أو اكتشفه.
- اتصل عبر بروتوكول Gateway.
- استدع طرق RPC الموثقة من مرجع Gateway RPC.
- ثبّت إصدار OpenClaw الذي تختبر عليه.
- راجع مرجع RPC عند ترقية OpenClaw.
لتشغيلات الوكيل، ابدأ بـ RPC الخاص بـ agent واقرنه بـ agent.wait عندما
تحتاج إلى نتيجة نهائية. لحالة محادثة دائمة، استخدم طرق sessions.*.
لتكاملات واجهة المستخدم، اشترك في أحداث Gateway واعرض فقط
عائلات الأحداث التي يفهمها تطبيقك.
كود التطبيق مقابل كود Plugin
استخدم Gateway RPC عندما يكون الكود خارج OpenClaw:
- سكربتات Node التي تبدأ تشغيلات الوكيل أو تراقبها
- مهام CI التي تستدعي Gateway
- لوحات المعلومات ولوحات الإدارة
- إضافات IDE
- الجسور الخارجية التي لا تحتاج إلى أن تصبح إضافات قنوات
- اختبارات التكامل مع عمليات نقل Gateway وهمية أو حقيقية
استخدم Plugin SDK عندما يعمل الكود داخل OpenClaw:
- إضافات المزوّدين
- إضافات القنوات
- أدوات أو خطافات دورة الحياة
- إضافات حاضنة الوكيل
- مساعدات وقت تشغيل موثوقة
يجب ألا تستورد التطبيقات الخارجية openclaw/plugin-sdk/*؛ فهذه المسارات الفرعية مخصصة
للإضافات التي يحمّلها OpenClaw.
