واجهة API Shell لـ cPanel
تتيح لك هذه الواجهة تشغيل دوال cPanel API بشكل تفاعلي.
تتوفّر هذه الواجهة لحسابات الموزّعين (reseller) فقط، وتقتصر على دوال cPanel API 2 وUAPI. تستخدم هذه الميزة بيانات حيّة من خادمك؛ فاستدعاءات الدوال قد تغيّر بيانات خادمك أو تحذفها، ما قد يؤدي إلى تعطّله. اقرأ توثيق أي دالة بعناية قبل استخدامها، وراجع قسم "نماذج الاستجابة" في توثيق مطوّري cPanel لمعرفة شكل المخرجات المتوقّعة.
تفعيل واجهة API Shell
لاستخدام هذه الميزة، يجب أن يفعّلها مزوّد الاستضافة لك عبر: تفعيل إعداد "cPanel & WHM API shell (for developers)" من تبويب System في واجهة Tweak Settings بـ WHM، ومنح ميزة API Shell لحسابك من واجهة Feature Manager.
استدعاء دالة API
اختر إصدار API: UAPI (API 3) أو API 2.
اختر دالة API من قائمة الإصدار المحدَّد.
في قسم المتغيرات، أدخل مفاتيح الدالة وقيمها في الخانات المخصّصة (أدخل كل الأزواج الإلزامية إن وُجدت). اضغط إضافة (Add) لإضافة متغيّر جديد، أو أيقونة X لإزالته.
لتصفية النتائج أو ترتيبها أو تقسيمها إلى صفحات، اضغط إظهار خيارات الترتيب/التصفية/التقسيم:
- فهرس أول نتيجة للعرض: أدخل رقمًا (يبدأ من صفر)؛ القيمة 0 تعرض كل النتائج دون حد.
- الحد الأقصى لعدد النتائج: أدخل رقمًا؛ القيمة 0 تعني بلا حد.
- التصفية: اضغط إضافة (Add) في قسم Filters، وحدّد الحقل والشرط (يحتوي، يبدأ بـ، يساوي، أكبر من، أصغر من) والقيمة.
- الترتيب: اضغط إضافة في قسم Sorts، وحدّد الحقل ونوع المقارنة (أبجدي، رقمي، رقمي مع اعتبار الصفر كأكبر قيمة، أو IPv4) واتجاه الترتيب.
- الأعمدة: اضغط إضافة في قسم Columns وأدخل رقم العمود المطلوب عرضه.
استخدم أيقونة X لإزالة أي عنصر أضفته في هذه الأقسام.
اضغط إرسال (Submit).
أثناء تعديل قيم الدالة، تُحدّث الواجهة تلقائيًا قسمَي الرابط (URL) وبنية بيانات استدعاء API.
استجابة استدعاء API
بعد الضغط على إرسال، تظهر مخرجات الدالة في قسم استجابة استدعاء API، ويمكنك عرضها بثلاث طرق: عرض شجري (Tree)، عرض جدولي (Table)، أو عرض خام (Raw).
يفصل العرض الخام استجابة الاستدعاء عن ترويسات HTTP. قد لا يتوفّر العرض الجدولي لبعض أنواع بيانات الدوال.
كيف تقيّم هذا الدليل؟