RPC and API
یکپارچهسازیهای Gateway برای برنامههای خارجی
برنامههای خارجی امروز باید از طریق پروتکل Gateway با OpenClaw ارتباط برقرار کنند. وقتی یک اسکریپت، داشبورد، کار CI، افزونه IDE یا فرایندی دیگر میخواهد اجرای عاملها را شروع کند، رویدادها را جریاندهی کند، منتظر نتایج بماند، کار را لغو کند یا منابع Gateway را بررسی کند، از WebSocket و روشهای RPC Gateway استفاده کنید.
آنچه امروز در دسترس است
| سطح | وضعیت | برای این مورد استفاده کنید |
|---|---|---|
| پروتکل Gateway | آماده | انتقال WebSocket، دستدهی اتصال، دامنههای احراز هویت، نسخهبندی پروتکل و رویدادها. |
| مرجع RPC Gateway | آماده | روشهای فعلی Gateway برای عاملها، نشستها، کارها، مدلها، ابزارها، مصنوعات و تأییدها. |
openclaw agent |
آماده | یکپارچهسازی اسکریپت یکباره وقتی فراخوانی CLI از پوسته کافی است. |
openclaw message |
آماده | ارسال پیامها یا کنشهای کانال از اسکریپتها. |
درخت منبع شامل کار بسته داخلی برای یک کتابخانه کلاینت آینده است، اما این یک سطح نصب عمومی نیست. تا زمانی که بستهها منتشر و نسخهبندی شوند، آن را جزئیات پیادهسازی پیشنمایش در نظر بگیرید.
مسیر پیشنهادی
- یک Gateway را اجرا یا کشف کنید.
- از طریق پروتکل Gateway متصل شوید.
- روشهای RPC مستندشده را از مرجع RPC Gateway فراخوانی کنید.
- نسخه OpenClaw را که در برابر آن آزمایش میکنید پین کنید.
- هنگام ارتقای OpenClaw، مرجع RPC را دوباره بررسی کنید.
برای اجرای عاملها، با RPC agent شروع کنید و وقتی
به نتیجه پایانی نیاز دارید، آن را با agent.wait همراه کنید. برای وضعیت گفتوگوی پایدار، از روشهای sessions.*
استفاده کنید. برای یکپارچهسازیهای رابط کاربری، در رویدادهای Gateway مشترک شوید و فقط خانوادههای رویدادی را که برنامه شما میفهمد رندر کنید.
کد برنامه در برابر کد Plugin
وقتی کد خارج از OpenClaw قرار دارد، از RPC Gateway استفاده کنید:
- اسکریپتهای Node که اجرای عاملها را شروع یا مشاهده میکنند
- کارهای CI که یک Gateway را فراخوانی میکنند
- داشبوردها و پنلهای مدیریت
- افزونههای IDE
- پلهای خارجی که نیازی ندارند به Pluginهای کانال تبدیل شوند
- آزمونهای یکپارچهسازی با انتقالهای Gateway جعلی یا واقعی
وقتی کد داخل OpenClaw اجرا میشود، از SDK Plugin استفاده کنید:
- Pluginهای ارائهدهنده
- Pluginهای کانال
- ابزار یا هوکهای چرخه عمر
- Pluginهای مهار عامل
- کمککنندههای زمان اجرای مورد اعتماد
برنامههای خارجی نباید openclaw/plugin-sdk/* را import کنند؛ این زیرمسیرها برای
Pluginهایی هستند که توسط OpenClaw بارگذاری میشوند.
