نظرة عامة على واجهة API
ثلاث نقاط نهاية للعمليات ومجسّان للصحة.
يُقدَّم Human Plugin عبر HTTP العادي على المنفذ الذي تضبطه (الافتراضي 8080). عنوان URL الأساسي هو المكان الذي تعرض فيه الحاوية داخل شبكتك، مثل http://human-plugin.internal:8080.
| الطريقة | المسار | الغرض |
|---|---|---|
POST | /v1/processes | إنشاء عملية، بأحد المسارات |
GET | /v1/processes/{id} | الحصول على عملية |
GET | /v1/processes/{id}/selfie | الحصول على صورة السيلفي |
GET | /health/live | الحيوية (Liveness). راجع الصحة والمراقبة |
GET | /health/ready | الجاهزية (فحص قاعدة البيانات) |
لا توجد نقطة نهاية لعرض العمليات أو حذفها أو البحث فيها، ولا مستقبِل webhook.
القواعد المطبقة على كل استدعاء
- لا توجد ترويسة مصادقة. لا يتحقق Human Plugin من جهات الاستدعاء. قيّد الوصول إلى الشبكة بدلاً من ذلك: راجع الشبكات والأمان.
- JSON فقط، بأسماء حقول camelCase.
- الاستجابات بالترويسة
Cache-Control: no-store. - تستخدم الأخطاء غلافاً واحداً،
{"message": "INVALID_REQUEST", "details": []}. راجع الأخطاء وإعادة المحاولة. idهو معرّف العملية لدى Human Plugin. احتفظ به من الإنشاء: فهو وسيلتك لقراءة العملية لاحقاً.
التسلسل المعتاد
التالي: إنشاء عملية.