التخطى الى المحتوى الأساسى
  1. التوثيق/

دليل الإعداد

1. تثبيت PocketHook
#

قم بتنزيل PocketHook من App Store وافتحه على iPhone أو iPad أو Mac.

2. إعداد الخادم الخاص بك
#

يحتاج PocketHook إلى نقطة اتصال HTTPS للتواصل. يمكنك استخدام:

  • خادم Agent — وكيل ذكاء اصطناعي مستضاف ذاتيًا مع LLM وأدوات ومهام خلفية وذاكرة
  • API الخاص بك — أي خادم يقبل طلبات POST ويعيد JSON
  • n8n — أتمتة سير العمل مستضافة ذاتيًا مع مشغل webhook
  • OpenClaw — مساعد ذكاء اصطناعي مستضاف ذاتيًا مع مراسلة متعددة القنوات

متطلبات الخادم
#

يجب أن يكون خادمك قادرًا على:

  • قبول طلبات POST مع محتوى JSON
  • إرجاع استجابات JSON
  • الوصول إليه عبر HTTPS (يتم رفض HTTP لأسباب أمنية)
  • دعم مصادقة Bearer token اختياريًا

3. الاتصال في PocketHook
#

  1. افتح PocketHook وانتقل إلى الإعدادات
  2. أدخل عنوان URL للخادم (يجب أن يكون HTTPS)
  3. أدخل رمز المصادقة (إذا كان خادمك يتطلب المصادقة)
  4. اضغط على اختبار الاتصال للتحقق

شاشة إعدادات PocketHook

4. صيغة الطلب
#

يرسل PocketHook الرسائل كمصفوفة JSON:

[{
  "sessionId": "uuid-v4",
  "action": "sendMessage",
  "chatInput": "رسالتك هنا"
}]

5. صيغة الاستجابة
#

يجب أن يستجيب خادمك بكائن JSON:

{
  "msg": "رسالة تُعرض للمستخدم",
  "shortcut": "اسم اختصار اختياري",
  "data": { "مفتاح": "قيمة" },
  "url": "https://optional-url.com"
}
الحقلالنوعمطلوبالوصف
msgstringنعمنص يُعرض في المحادثة
shortcutstringلااختصار iOS للتنفيذ
dataobject | arrayلابيانات تُمرر إلى الاختصار
urlstringلاعنوان URL للفتح أو العرض

للأتمتة متعددة الخطوات، أرجع مصفوفة من الاستجابات:

[
  { "msg": "الخطوة 1...", "shortcut": "الاختصار الأول" },
  { "msg": "الخطوة 2...", "shortcut": "الاختصار الثاني", "data": { "input": "قيمة" } }
]

6. البدء السريع مع خادم Starter
#

استخدم قالب خادم starter الخاص بنا للبدء في دقائق:

git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# حرّر .env برمزك السري
bun dev

يتضمن starter أوامر مدمجة (ping، hello، help، time) وأمثلة لتشغيل الاختصارات. راجع مرجع API للمواصفات الكاملة للبروتوكول.

7. استخدام SDK
#

ثبّت حزمة pockethook-sdk لبناء استجابات آمنة النوع:

bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";

// استجابة نصية بسيطة
return toResponse(text("مرحبًا من خادمي!"));

// تشغيل اختصار
return toResponse(shortcut("جارٍ التنفيذ...", "اختصاري", { مفتاح: "قيمة" }));

// أتمتة متعددة الخطوات
return toResponse(responses([
  { msg: "الخطوة 1", shortcut: "الأول" },
  { msg: "الخطوة 2", shortcut: "الثاني" }
]));