الانتقال إلى المحتوى الرئيسي
يكشف ResQ واجهتي API عبر HTTPS:
APIعنوان URL الأساسيالبِنية التقنية
Infrastructure APIhttps://api.resq.softwareRust + Axum
Coordination APIhttps://coordination.resq.softwareTypeScript + Elysia
إذا كنت تشغّل نشرًا ذاتي الاستضافة، استبدل عناوين URL الأساسية أعلاه بعناوينك. أشكال الطلبات متطابقة.

​
الخطوات

1

تأكَّد من أن الخدمة قيد التشغيل

استدعِ /health على Infrastructure API. لا يتطلب مصادقة.
curl https://api.resq.software/health
تبدو الاستجابة السليمة هكذا:
{
  "status": "ok",
  "pinata": true,
  "gemini": true,
  "spoon_os": "0.1.0"
}
2

احصل على JWT

يستخدم Infrastructure API توكنات JWT من نوع bearer. استبدل بيانات الاعتماد بتوكن على POST /login.
curl -X POST https://api.resq.software/login \
  -H "Content-Type: application/json" \
  -d '{"username":"اسم-المستخدم-الخاص-بك","password":"كلمة-المرور-الخاصة-بك"}'
تحمل الاستجابة توكنًا وطابع وقت Unix لانتهاء الصلاحية:
{
  "token": "eyJhbGciOi...",
  "expires_at": 1746345600
}
احفظ التوكن بأمان. للحصول على إرشادات التحديث والتدوير راجع المصادقة.
3

استدعِ نقطة نهاية مُصادَقة

أرسل التوكن كرأس Bearer.
curl https://api.resq.software/evidence \
  -H "Authorization: Bearer $RESQ_TOKEN"
4

استقبل القياس عن بُعد من Coordination API

يكشف Coordination API مقاييس Prometheus وأحداث Server-Sent Events لحالة الأسطول في الوقت الفعلي.
curl -N https://coordination.resq.software/events
كل سطر هو حدث JSON: إطارات قياس عن بُعد، تغيّرات حالة المهمة، وموافقات HITL.
5

اختر SDK

تجنّب كتابة عميل — ثبّت أحد SDKs الرسمية بدلاً من ذلك.

TypeScript

@resq-sw/http، @resq-sw/security، مكوّنات UI.

Python

resq-mcp (خادم FastMCP) و resq-dsa.

Rust

resq CLI الموحَّد بالإضافة إلى سبع أدوات TUI.

.NET

عملاء بأنواع، عقود Protobuf، أُطُر محاكاة.

​
التالي

المصادقة

دورة حياة JWT والتدوير.

الأخطاء

غلاف الأخطاء ورموز الحالة.

مرجع API

كل نقاط النهاية والطلبات والاستجابات.