Skip to main content

واجهات برمجة ResQ

تكشف ResQ عن واجهتين رئيسيتين لتنسيق الاستجابة للكوارث:

Infrastructure API

إدارة الحوادث، جمع الأدلة، التحقق عبر البلوكشين، تحليل الذكاء الاصطناعي، وعمليات Solana على السلسلة.

Coordination API

تنسيق أسطول الطائرات بدون طيار في الوقت الفعلي، استيعاب القياسات عن بُعد، تخزين IPFS، حقن الأخطاء، وموافقة المهام (HITL).

عناوين URL الأساسية

عمليات النشر الذاتية تستبدل أسماء المضيفين بأسمائها الخاصة؛ أشكال الطلب والاستجابة متطابقة.

المصادقة

تستخدم كلتا الواجهتين رموز JWT من نوع bearer.
راجع المصادقة لدورة حياة الرمز، ومعالجة الصلاحيات، وإرشادات التدوير.

الاصطلاحات

نوع المحتوى

تستخدم جميع الطلبات والاستجابات application/json ما لم توثّق نقطة نهاية صراحةً نوع وسائط مختلفًا (على سبيل المثال، الرفع متعدد الأجزاء على POST /storage).

الوقت

الطوابع الزمنية في حمولات الموارد هي سلاسل ISO-8601 بتوقيت UTC (2026-05-04T06:01:27Z). انتهاء صلاحية الرمز في /login هو الاستثناء — فهو طابع زمني Unix بالثواني لتسهيل العمليات الحسابية.

المعرّفات

معرّفات الموارد سلاسل غير شفافة. لا تحلّلها؛ تعامل معها كمعرّفات فقط. يُشار إلى أدلة IPFS عبر CID (معرّف المحتوى)، وهو معرّف مبني على المحتوى ومستقر.

التقسيم إلى صفحات

تقبل نقاط نهاية القوائم معاملي الاستعلام limit (الافتراضي 50، الحد الأقصى 200) وcursor. تحمل الاستجابة الحقل next_cursor عند توفّر صفحات إضافية.

الإتقان التكراري (Idempotency)

تقبل نقاط النهاية المُعدِّلة الترويسة Idempotency-Key. تخزّن ResQ الاستجابة مؤقتًا لمدة 24 ساعة، لذا تُعيد المحاولات النتيجة الأصلية بدلًا من تكرار الأثر الجانبي.

معرّفات الطلبات

تحمل كل استجابة الترويسة X-Request-Id. أدرجها في أي بلاغ دعم أو حادثة حتى نتمكن من ربط السجلات.

الأخطاء

تستخدم حالات الفشل رموز حالة HTTP القياسية مع غلاف JSON صغير. راجع الأخطاء للجدول الكامل لرموز الحالة، وإرشادات إعادة المحاولة، ومخطط التراجع التدريجي.

Infrastructure API

مبنية بـ Rust/Axum. تتعامل مع البيانات الدائمة، وتفاعلات البلوكشين، والتحليل المدعوم بالذكاء الاصطناعي. عنوان URL الأساسي: https://api.resq.software.

Coordination API

مبنية بـ TypeScript/Elysia. تتعامل مع عمليات الأسطول في الوقت الفعلي وتنسيق المهام.

حِزم التطوير (SDKs)

تجنّب كتابة عميل من الصفر — ثبّت إحدى حزم التطوير الرسمية.

TypeScript

@resq-systems/http و@resq-systems/security ومكوّنات واجهة المستخدم.

Python

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

Rust

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

.NET

عملاء مُنمّطون، وعقود Protobuf، وبيئات محاكاة.