واجهة API Shell الخاصة بـ cPanel

نظرة عامة

الواجهة دي بتسمحلك بتشغيل cPanel API Functions بشكل مباشر وتفاعلي من داخل cPanel.

مهم:

• الواجهة دي متاحة فقط لحسابات Reseller.
• الواجهة الخاصة بـ API Shell بتدعم فقط دوال cPanel API 2 و UAPI.

⚠️ تحذير:

الميزة دي بتستخدم بيانات حقيقية ومباشرة (Live Data) من السيرفر بتاعك. استدعاء بعض الـ API Functions ممكن يؤدي إلى تعديل أو حذف بيانات موجودة على السيرفر، وده ممكن يتسبب في توقف السيرفر عن العمل بشكل صحيح.

لذلك:

• اقرأ توثيق الـ Function اللي هتستخدمها بشكل كامل ودقيق قبل تشغيلها من خلال API Shell.
• لو عايز تشوف مثال على النتيجة اللي الـ Function بترجعها، راجع قسم Response Samples الخاص بالـ Function في توثيق cPanel Developer Documentation.

تفعيل API Shell

علشان تستخدم الميزة دي، لازم مزود الاستضافة (Hosting Provider) يفعّلها لحسابك.

اطلب منه تنفيذ الخطوات التالية من WHM:

1. من إعدادات WHM » Home » Server Configuration » Tweak Settings، افتح تبويب System، وبعدها خلي إعداد cPanel & WHM API shell (for developers) على On.
2. من واجهة WHM » Home » Packages » Feature Manager، أضف ميزة API Shell إلى Feature List الخاصة بحسابك.

تشغيل API Function

لتشغيل API Function، اتبع الخطوات التالية:

1. من قسم cPanel API version، اختار الإصدار اللي هتستخدمه:
   • UAPI (API 3)
   • API 2
2. اختار الـ API Function اللي عايز تشغلها من قائمة الإصدار اللي اخترته.
3. من قسم Variables، اكتب الـ Keys والـ Values الخاصة بالـ API Function في الخانات المخصصة.
   • لو الـ Function محتاجة Required Parameters، لازم تدخلها.
   • لإضافة Variable جديدة، اضغط Add.
   • لحذف Variable، اضغط على علامة X.

4. لو عايز تعمل Filter أو Sort أو Pagination للنتائج، اضغط على Show Sort/Filter/Paginate Options.

   تحديد أول نتيجة

   من خانة Index of first results to show, zero-based، اكتب رقم أول نتيجة عايز تظهر، أو اختار الرقم من القائمة.

   • القيمة 0 بتعرض عدد غير محدود من النتائج.

   تحديد عدد النتائج

   من خانة Maximum # of results to show، حدد أقصى عدد للنتائج اللي عايز تظهر.

   • القيمة 0 بتعرض عدد غير محدود من النتائج.

   تصفية النتائج (Filters)

   من قسم Filters، اضغط Add لإضافة فلتر جديد.

   تقدر تحدد:

   • الـ Field اللي عايز تعمل عليه Filter.
   • نوع الشرط:
     • Contains — يحتوي على
     • Begins With — يبدأ بـ
     • Equals — يساوي
     • Greater Than (numeric) — أكبر من (رقمي)
     • Less Than (numeric) — أقل من (رقمي)
   • القيمة أو الـ Term اللي هيتم تطبيق الشرط عليها.
   • لإضافة Filter جديد، اضغط Add.
   • لحذف Filter، اضغط على علامة X.

   ترتيب النتائج (Sorts)

   من قسم Sorts، اضغط Add لإضافة طريقة ترتيب للنتائج.

   تقدر تحدد:

   • الـ Field اللي عايز ترتب النتائج بناءً عليه.
   • نوع الترتيب:
     • lexicographic
     • numeric
     • numeric_zero_as_max
     • ipv4
   • وتقدر كمان تحدد إذا كنت عايز تعكس ترتيب النتائج.
   • لإضافة طريقة ترتيب جديدة، اضغط Add.
   • لحذف طريقة ترتيب، اضغط على علامة X.

   تحديد الأعمدة (Columns)

   لو عايز تحدد الأعمدة اللي تظهر في النتائج، من قسم Columns اضغط Add.

   بعد كده اكتب رقم العمود في خانة Column.

   • لإضافة أعمدة أخرى، اضغط Add.
   • لحذف عمود، اضغط على علامة X.
5. بعد ما تخلص الإعدادات، اضغط Submit.

أثناء تعديل قيم الـ API Function، الواجهة بتقوم تلقائيًا بتحديث بيانات قسمي URL و API Call Data Structure.

نتيجة API Call

بعد ما تضغط Submit، هتظهر نتيجة الـ API Function في قسم API Call Response.

وتقدر تشوف النتيجة من خلال 3 طرق:

• Tree View — عرض النتائج في شكل شجرة.
• Table View — عرض النتائج في شكل جدول.
• Raw View — عرض البيانات الخام للـ API Response.

ملاحظة:

• تبويب Raw View بيفصل الـ API Response عن HTTP Headers.
• تبويب Table View ممكن ما يكونش متاح لبعض أنواع البيانات اللي بترجعها الـ Function.