Skip to content

API HTTP وقت التشغيل ​

يقدم Ironloom الإعداد والصحة والجاهزية على منفذ HTTP الحالي لوقت التشغيل.

GET /healthz ​

يرجع 200 ok عندما يكون خادم HTTP حيا.

GET /readyz ​

يرجع 200 ok فقط عندما يمكن حل تهيئة وقت التشغيل المطلوبة من قيم البيئة أو الإعداد المحلي المشفر. يرجع 503 setup required ما دام الإعداد غير مكتمل.

GET / ​

يرجع صفحة الإعداد.

GET /setup ​

يرجع صفحة الإعداد.

إذا كان IRONLOOM_CONFIG_KEY مفقودا أو غير صالح، تعرض الصفحة تعليمات المفتاح ولا تعرض حقول إدخال الإعداد.

إذا كان IRONLOOM_INSTALLER_TOKEN مفقودا، تعرض الصفحة تعليمات رمز التثبيت.

عندما تكون متطلبات الإعداد موجودة، تعرض الصفحة نموذج التهيئة. تقفل الحقول المدعومة من البيئة ولا تعرض القيم السرية.

POST /setup ​

يقبل قيم نموذج الإعداد بعد أن يطابق رمز التثبيت المرسل IRONLOOM_INSTALLER_TOKEN.

تكتب الإرسالات الناجحة تهيئة إعداد مشفرة تحت IRONLOOM_STATE_ROOT وترجع 200 setup saved.

ترجع رموز التثبيت غير الصالحة 403 setup rejected.

POST /setup/openai/oauth/start ​

يرجع تعليمات إعداد OpenAI OAuth التي تستخدمها صفحة التهيئة. يمكن حفظ مرجع جلسة OAuth الناتج من خلال نموذج الإعداد أو ربطه عبر IRONLOOM_OPENAI_OAUTH_SESSION.

POST /setup/discord/oauth/start ​

يرجع صفحة تفويض Discord لمعرف التطبيق المهيأ. يستخدم العنوان المولد النطاقين bot وapplications.commands حتى يتمكن مسؤول خادم Discord من تثبيت Ironloom في الخادم الهدف.

POST /discord/interactions ​

يقبل webhooks تفاعلات Discord الموقعة باستخدام X-Signature-Ed25519 وX-Signature-Timestamp.

ترجع تفاعلات ping حمولة pong الخاصة ب Discord. تحل تفاعلات أوامر التطبيق قناة Discord كخيط للمشغل، وتتطلب ربطا محفوظا واحدا بعنصر عمل، وتوزع عامل البوابة المختار عبر المشرف، وتكتب قطعة أثرية، وترجع استجابة رسالة قناة. ترجع التواقيع غير الصالحة 401 قبل تشغيل أي عمل.

Contributors

The avatar of contributor named as Vanna DiCatania Vanna DiCatania

Changelog

عمليات هندسية قابلة للتدقيق لـ Discord وGitHub وSonarCloud وk3s.