Skip to main content
يكشف ResQ واجهتي API عبر HTTPS:
إذا كنت تشغّل نشرًا ذاتي الاستضافة، استبدل عناوين URL الأساسية أعلاه بعناوينك. أشكال الطلبات متطابقة.

الخطوات

1

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

استدعِ /health على Infrastructure API. لا يتطلب مصادقة.
تبدو الاستجابة السليمة هكذا:
2

احصل على JWT

يستخدم Infrastructure API توكنات JWT من نوع bearer. استبدل بيانات الاعتماد بتوكن على POST /login.
تحمل الاستجابة توكنًا وطابع وقت Unix لانتهاء الصلاحية:
احفظ التوكن بأمان. للحصول على إرشادات التحديث والتدوير راجع المصادقة.
3

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

أرسل التوكن كرأس Bearer.
4

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

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

اختر SDK

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

TypeScript

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

Python

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

Rust

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

.NET

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

التالي

المصادقة

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

الأخطاء

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

مرجع API

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