API7 Enterprise v3.3.0 يدعم API Portal

نظرة عامة على بوابة المطورين

بوابة المطورين هي منصة مخصصة لمستهلكي واجهات برمجة التطبيقات (APIs) (مثل المطورين الخارجيين والفرق الداخلية) التي توفر وصولًا موحدًا إلى وثائق واجهات برمجة التطبيقات، وأدوات الاختبار، والموارد ذات الصلة. لا تسهل هذه البوابة على المطورين فهم ودمج واجهات برمجة التطبيقات فحسب، بل تعزز أيضًا القدرات البصرية والتحكمية على مستويات الإدارة والأمان. بالنسبة لمنصة بوابة واجهات برمجة التطبيقات، فإن تقديم بوابة المطورين يتيح ما يلي:

1. تبسيط تعريض واجهات برمجة التطبيقات: من خلال تجميع الوثائق المتناثرة، والأمثلة، ومواصفات الواجهات في منصة موحدة، تقلل البوابة بشكل كبير من تكاليف التكامل وتسريع تكامل المنتج مع الأنظمة الخارجية.

2. تحسين كفاءة البحث والتطوير والعمليات: توفر الميزات الذاتية مثل البحث في الوثائق، والاختبار، والتصحيح تقليل التواصل المتكرر وصيانة الوثائق، مما يعزز الكفاءة العامة.

3. الإدارة المركزية والمراقبة: توفر المنصة تتبعًا أفضل لاستخدام واجهات برمجة التطبيقات، وتحليل الاستجابات، ومراقبة المقاييس الرئيسية، بالإضافة إلى الكشف المبكر عن المشكلات المحتملة.

في إصدار API7 Enterprise 3.3.0، تدعم بوابة API7 Gateway الآن إنشاء بوابة المطورين تلقائيًا مباشرة من وثائق واجهات برمجة التطبيقات التي يوفرها المستخدم. تمكن هذه القدرة المنظمات من تعريض موارد واجهات برمجة التطبيقات للجهات الخارجية بسهولة أكبر مع تقديم تجربة متسقة ومريحة للمطورين.

بوابة API7 للمزودين وبوابة المطورين

كمنصات لإدارة واجهات برمجة التطبيقات، تلعب بوابة API7 للمزودين وبوابة المطورين أدوارًا مكملة ولكنها تخدم جماهير ووظائف مختلفة.

بوابة API7 للمزودين

بوابة API7 للمزودين هي وحدة تحكم إدارة مصممة لمزودي واجهات برمجة التطبيقات لتسهيل إدارة دورة حياة واجهات برمجة التطبيقات بسهولة.

• الجمهور المستهدف: مزودو واجهات برمجة التطبيقات والمسؤولون
• الوظائف الأساسية:
  • نشر وإدارة منتجات واجهات برمجة التطبيقات.
  • إدارة المطورين.
  • تكوين سياسات الوصول إلى بوابة المطورين، مثل عرض واجهات برمجة التطبيقات بشكل مجهول وطرق تسجيل الدخول.
  • تصور إحصائيات الوصول إلى واجهات برمجة التطبيقات، وإجراء التحليلات، وتتبع السجلات.

بوابة API7 للمطورين

توفر بوابة API7 للمطورين نقطة دخول موحدة وذاتية الخدمة للمطورين أو الشركاء، مما يمكنهم من فهم واجهات برمجة التطبيقات والوصول إليها واستخدامها بسرعة.

• الجمهور المستهدف: مستهلكو واجهات برمجة التطبيقات، مثل المطورين الخارجيين، الشركاء، أو فرق التطوير الداخلية
• الوظائف الأساسية:
  • توفير وثائق واجهات برمجة التطبيقات، أدلة الاستخدام، وأمثلة التعليمات البرمجية.
  • تقديم واجهات اختبار وتصحيح عبر الإنترنت.
  • إدارة تسجيل التطبيقات، الحصول على مفاتيح واجهات برمجة التطبيقات، والتعامل مع بيانات الاعتماد المصادقة.

كيفية استخدام بوابة API7

الوصول إلى بوابة API7 للمزودين

بعد تسجيل الدخول إلى لوحة تحكم API7 Enterprise، يتم توجيه المستخدمين إلى صفحة إدارة البوابة بشكل افتراضي. للتبديل إلى بوابة API7 للمزودين، انقر على زر التبديل في الزاوية العلوية اليسرى. عند التبديل، يتم تحديث عنوان الصفحة إلى بوابة API7 للمزودين، ويعكس القائمة على اليسار الخيارات ذات الصلة لإدارة منتجات واجهات برمجة التطبيقات.

إنشاء ونشر منتجات واجهات برمجة التطبيقات

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

1. بناءً على الخدمات المنشورة في بوابة API7 Gateway

• حدد الخدمات المنشورة الموجودة في بوابة API7 Gateway وقم بتجميعها في منتج واجهات برمجة التطبيقات.
• داخل منتج واجهات برمجة التطبيقات، يتم التعامل مع كل خدمة كواجهات برمجة تطبيقات مستقلة.

2. استيراد ملفات OpenAPI

• قم بإنشاء منتجات واجهات برمجة التطبيقات بسرعة عن طريق استيراد ملفات OpenAPI الموجودة.
• لاحظ أن المنتجات التي تم إنشاؤها بهذه الطريقة لا ترتبط مباشرة بتكوينات البوابة.

مثال: إضافة منتج واجهات برمجة التطبيقات من بوابة API7 Gateway

لإضافة منتج واجهات برمجة التطبيقات، انقر على زر "إضافة منتج واجهات برمجة التطبيقات" وحدد عنصر القائمة "من بوابة API7 Gateway" للوصول إلى نموذج إنشاء منتج واجهات برمجة التطبيقات.

في النموذج، تحتاج إلى ملء المعلومات التالية:

1. الأساسيات: تشمل الاسم، الوصف، التسميات، الشعار، إلخ.

2. نوع المصادقة: حدد ما إذا كان التصديق مطلوبًا.

3. الرؤية: حدد نطاق رؤية منتج واجهات برمجة التطبيقات.

4. الخدمات المرتبطة بالبوابة: حدد خدمة بوابة منشورة تلبي الشرطين التاليين:

   • تم تكوين اسم مضيف.
   • تم تحميل وثيقة OpenAPI.

إضافة منتج واجهات برمجة التطبيقات جديد

إذا لم تكن هناك خدمات تلبي المتطلبات، يمكنك اتباع خطوات التكوين التالية.

1. تحميل وثيقة OpenAPI وتكوين اسم المضيف للخدمات الموجودة

في صفحة تفاصيل الخدمة أو صفحة قالب الخدمة، انقر على مواصفات OpenAPI في شريط التنقل الأيسر. ثم قم بتحميل وثيقة OpenAPI المقابلة للخدمة. تأكد من أن تعريفات واجهات برمجة التطبيقات في الوثيقة تتطابق تمامًا مع مسارات الخدمة الفعلية. يضمن ذلك للمطورين وثائق واجهات برمجة التطبيقات الدقيقة أثناء التصحيح والوصول الناجح إلى المصدر.

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

بعد ذلك، في قسم المسارات في صفحة تفاصيل الخدمة أو صفحة تفاصيل القالب، قم بتكوين hosts في وحدة عنوان الطلب. بشكل افتراضي، يتم تعيين hosts إلى "*"، مما يعني أن الخدمة تعالج الطلبات من أي اسم مضيف.

لربط الخدمة بمنتج واجهات برمجة التطبيقات، يجب تحديد اسم مضيف دقيق. يضمن هذا المتطلب أن يتمكن المطورون من الوصول إلى واجهات برمجة التطبيقات باستخدام تنسيق المسار الكامل: host + بادئة المسار + واجهة برمجة التطبيقات.

2. إنشاء خدمة جديدة لربطها بمنتج واجهات برمجة التطبيقات

إذا لم يتم نشر أي خدمات، يمكنك إنشاء خدمة جديدة عن طريق تحميل وثيقة OpenAPI كقالب خدمة ونشرها، أو عن طريق إنشاء خدمة في مجموعة البوابة مباشرة. الخدمات التي تم إنشاؤها بهذه الطريقة تقوم تلقائيًا بتحليل واجهات برمجة التطبيقات المحددة في OpenAPI إلى مسارات، مع الاحتفاظ بالوثيقة دون الحاجة إلى إعادة التحميل. قم بتكوين host كما هو موضح سابقًا لجعل الخدمة مؤهلة للربط بمنتج واجهات برمجة التطبيقات.

بعد اكتمال تكوين البوابة، ارجع إلى بوابة المزودين وانقر على إضافة خدمة بوابة مرتبطة. حدد الخدمة المنشورة المطلوبة لإكمال الربط.

بشكل افتراضي، سيكون منتج واجهات برمجة التطبيقات الذي تم إنشاؤه حديثًا في حالة مسودة، وغير مرئي للمطورين. قبل النشر، قم بمراجعة وثائق واجهات برمجة التطبيقات، وإعدادات الرؤية، وإعدادات المصادقة. يوصى بتكوين إشعارات أحداث منتج واجهات برمجة التطبيقات (مثل الموافقة على الاشتراك أو الإلغاء) لتجنب فقدان التحديثات الحرجة.

نشر منتج واجهات برمجة التطبيقات

بعد التحقق من منتج واجهات برمجة التطبيقات، انقر على زر النشر في الزاوية العلوية اليمنى وقم بالتأكيد. يمكن للمطورين الذين يتطابقون مع إعدادات الرؤية بعد ذلك الوصول إلى المنتج من خلال بوابة المطورين.

الوصول إلى بوابة API7 للمطورين

يمكنك الوصول إلى بوابة API7 للمطورين بطريقتين:

1. قم بزيارة عنوان URL الخاص ببوابة المطورين.
2. انقر على زر بوابة المطورين في القائمة اليسرى من لوحة تحكم بوابة API7.

في الصفحة الرئيسية لبوابة API7 للمطورين، انقر على زر تسجيل الدخول في الزاوية العلوية اليمنى لتسجيل الدخول.

إنشاء مطور

هناك طريقتان لإنشاء حساب مطور:

• التسجيل الذاتي: يقوم المطورون بالتسجيل بأنفسهم في صفحة تسجيل الدخول.
• دعوة المسؤول: يقوم المسؤولون بإنشاء الحسابات عبر لوحة تحكم بوابة API7.

التسجيل الذاتي

انقر على زر التسجيل في صفحة تسجيل الدخول، وأكمل النموذج باسم المستخدم وكلمة المرور.

التسجيل الذي يبدأه المسؤول

في لوحة تحكم بوابة API7، انتقل إلى قسم المطورين وانقر على دعوة مطور. قم بملء النموذج باسم المستخدم وكلمة مرور لمرة واحدة، ويمكنك أيضًا تقديم اسم عرض للتعريف.

بعد إضافة المطور، شارك اسم المستخدم وكلمة المرور مع المستخدم. عند أول تسجيل دخول، يجب عليهم إعادة تعيين كلمة المرور.

عرض منتجات واجهات برمجة التطبيقات

بعد تسجيل الدخول، يمكن للمطورين النقر على مركز واجهات برمجة التطبيقات لعرض جميع منتجات واجهات برمجة التطبيقات المنشورة.

بالإضافة إلى عرض وثائق واجهات برمجة التطبيقات، يدعم النظام أيضًا إنشاء نماذج تعليمات برمجية متعددة اللغات لكل واجهة برمجة تطبيقات في صفحة التفاصيل. يمكن للمطورين نسخ هذه النماذج التعليمية إلى بيئة التطوير الخاصة بهم للاختبار.

اختبار منتجات واجهات برمجة التطبيقات

بالإضافة إلى ذلك، يمكن للمطورين اختبار واجهات برمجة التطبيقات مباشرة عن طريق النقر على زر اختبار الطلب.

بعد النقر على اختبار الطلب، يمكنك رؤية لوحة اختبار عبر الإنترنت.

• يتم إنشاء عنوان الطلب تلقائيًا بناءً على تكوين الخدمة المرتبطة بمنتج واجهات برمجة التطبيقات.
• يتم تعيين طريقة المصادقة افتراضيًا إلى مصادقة المفتاح ويملأ تلقائيًا مفتاح واجهة برمجة التطبيقات لحساب المطور الحالي.

يحتاج المطورون فقط إلى إكمال معلمات الطلب المطلوبة وفقًا لتعريف واجهة برمجة التطبيقات للمتابعة في الاختبار.

الاشتراك في منتجات واجهات برمجة التطبيقات

إذا كان منتج واجهات برمجة التطبيقات مقيدًا لمستخدمين محددين، يمكن لمسؤول بوابة المزودين تعطيل خيار يمكن للمطورين غير المشتركين عرض تفاصيل واجهات برمجة التطبيقات في إعدادات رؤية المنتج. يضمن ذلك أن المطورين يجب عليهم الاشتراك في المنتج قبل الوصول إلى واجهات برمجة التطبيقات أو استدعائها.

عندما يصل المطور إلى صفحة تفاصيل منتج واجهات برمجة التطبيقات تحت هذا الإعداد، سيظهر زر "الاشتراك للفتح". يؤدي النقر على الزر إلى إرسال طلب اشتراك إلى مسؤول المزود.

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

في قائمة المؤسسة في بوابة API7 للمزودين، إذا كانت هناك طلبات معلقة، ستظهر نقطة حمراء بجوار عنصر القائمة الموافقات كإشارة. يؤدي النقر على عنصر القائمة هذا إلى الانتقال إلى صفحة إدارة الموافقات.

تم تصميم صفحة الموافقات لإدارة طلبات المطورين للوصول إلى موارد واجهات برمجة التطبيقات. يمكن للمسؤولين مراجعة المعلومات التالية حول الطلبات في هذه الصفحة: نوع الحدث، اسم المورد، مقدم الطلب، ووقت التقديم. من خلال الواجهة، يمكن للمسؤولين اتخاذ إجراء بالموافقة أو الرفض على الطلب.

يؤثر قرار الموافقة مباشرة على أذونات وصول المطور إلى واجهات برمجة التطبيقات:

• الموافقة: يحصل المطور على إذن لعرض صفحة تفاصيل منتج واجهات برمجة التطبيقات واستدعاء واجهة برمجة التطبيقات.
• الرفض: يجب على المطور التواصل مع المسؤول، وإجراء التعديلات اللازمة بناءً على الملاحظات، وإعادة تقديم الطلب.

الخلاصة

تدمج API7 Enterprise منصة بوابة واجهات برمجة التطبيقات مع بوابة المطورين لإنشاء حل فعال لإدارة واجهات برمجة التطبيقات لكل من مزودي واجهات برمجة التطبيقات والمطورين.

تمكن بوابة API7 للمزودين مزودي واجهات برمجة التطبيقات من نشر وإدارة ومراقبة منتجات واجهات برمجة التطبيقات بسهولة مع تنسيق موارد المطورين بشكل فعال. في الوقت نفسه، يمكن للمطورين فهم ودمج واستخدام خدمات واجهات برمجة التطبيقات بسرعة، مما يعجل بتطوير التطبيقات. تعمل هاتان البوابتان معًا لتبسيط عملية إدارة دورة حياة واجهات برمجة التطبيقات، مما يجعل كل خطوة من النشر إلى الاستدعاء أكثر سلاسة وكفاءة.