إنشاء بوابة متكاملة

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

توفّر Apigee Edge بوابة متكاملة سهلة الاستخدام لتوثيق وإدارة الوصول إلى واجهات برمجة التطبيقات، وتعزيز منتدى مطوّري التطبيقات.

يمكن لجميع مستخدمي Apigee Edge الوصول إلى أدوات تطوير البوابة المتكاملة التي تتيح لهم إنشاء بوابة المطوّرين الخاصة بهم بسرعة، ما يوفّر بديلاً لتطوير البوابة المستندة إلى Drupal. لمقارنة الميزات، يُرجى الاطّلاع على مقارنة ميزات بوابة المطوّرين.

يمكنك مشاهدة هذا الفيديو القصير للحصول على مقدمة حول إنشاء البوابة المتكاملة ونشرها.

الميزات والمزايا الأساسية

توفّر لك البوابة المتكاملة الميزات والمزايا الرئيسية التالية:
إبراز المزايا
تطوير محتوى البوابة تطوير محتوى البوابة بسرعة وسهولة
  • إنشاء صفحات باستخدام محرر الصفحات سهل الاستخدام
  • استخدام Markdown وHTML لإنشاء المحتوى
  • إضافة قوائم للتنقل في البوابة
شكل وأسلوب البوابة يمكنك تخصيص شكل وأسلوب البوابة بالكامل باستخدام أوراق أنماط SCSS والعلامة التجارية المخصصة.
مستند واجهة برمجة التطبيقات إنشاء الوثائق المرجعية لواجهة برمجة التطبيقات تلقائيًا بناءً على مواصفات OpenAPI.
تسجيل الخدمة الذاتية يمكنك توفير تسجيل بنظام الخدمة الذاتية للمطوّرين من أجل إنشاء تطبيقات باستخدام واجهات برمجة التطبيقات.
إدارة الجمهور التحكّم في المستخدمين الذين يمكنهم الوصول إلى محتوى البوابة وواجهات برمجة التطبيقات
الإحصاءات ضبط "إحصاءات Google" وتتبع الإحصاءات المخصّصة.
تخصيصات متقدمة تنفيذ عمليات تخصيص متقدمة للبوابة، بما في ذلك:
  • تخصيص نطاقك
  • إضافة حقول تسجيل مخصّصة
  • توسيع البوابة باستخدام النصوص البرمجية
  • ضبط بريدك الإلكتروني

البدء في إنشاء البوابة

كيف تتعامل Apigee مع الأمان في البوابة المتكاملة

يوضّح الجدول التالي كيفية تعامل Apigee مع الأمان من خلال الميزات المضمَّنة في البوابة المتكاملة.

إبراز العناوين
يتطلب HTTPS وبروتوكول أمان طبقة النقل (بروتوكول أمان طبقة النقل) فرض الاتصال المشفّر
يشمل ذلك تسجيل النطاق apigee.io مع قائمة اللواحق العامة. عدم السماح بضبط "ملف تعريف الارتباط الفائق" على نطاقات apigee.io الفرعية
إمكانية ضبط سياسة أمان المحتوى (CSP) الحماية من هجمات البرمجة النصية على مستوى المواقع الإلكترونية (XSS) وغيرها من هجمات إدخال الرموز
المتطلبات:
  • تصحيح إدخال النموذج
  • حصر إمكانية إدخال JavaScript على مستوى الموقع الإلكتروني على المشرفين
الحماية من هجمات حقن HTML أو SQL أو الخلفية
يتضمّن عنوان XSS واحد (x-content-type-options: nosniff). يمنع هذا الخيار المتصفِّحات من محاولة تخمين أنواع MIME.
يتضمّن عنوان XSS واحد (x-frame-options: deny). عدم السماح بتضمين محتوى المدخل في إطار iframe
يتضمّن عنوان XSS واحد (x-xss-protection: 1). عدم السماح بتحميل الصفحات عند رصد هجمات البرمجة النصية على مستوى المواقع الإلكترونية المنعكسة (XSS)
يستخدم رموز CSRF المميزة الحماية من تزوير طلبات المواقع الإلكترونية المختلفة
الاستفادة من المزايا: إجراءات حماية بيانات العملاء

كيفية تواصل البوابة المتكاملة مع Edge

يتم تخزين معظم المعلومات التي تستخدمها بوابة المطوّرين في Apigee Edge. تعمل البوابة كعميل لبرنامج Edge. حسب الضرورة، ترسل بوابة المطوّر طلب HTTP أو HTTPS REST لاسترداد المعلومات من Edge أو إرسالها إليه. على سبيل المثال، عندما يسجّل مستخدم البوابة تطبيقًا جديدًا على البوابة، ترسل البوابة طلبًا إلى Edge لتخزين معلومات حول التطبيق.

تقدم الأقسام التالية المزيد من التفاصيل.

مكان تخزين تسجيل التطبيقات ومفاتيح واجهة برمجة التطبيقات

عندما يُكمل مستخدم البوابة عملية تسجيل التطبيق على البوابة المتكاملة، ترسل البوابة معلومات حول التطبيق إلى Apigee Edge، بما في ذلك اسم التطبيق ومنتجات واجهة برمجة التطبيقات المرتبطة بالتطبيق. وإذا سجّل Edge التطبيق بنجاح، تعرض Edge مفتاح واجهة برمجة تطبيقات واحدًا إلى البوابة. يستخدم مستخدم البوابة مفتاح واجهة برمجة التطبيقات هذا للوصول إلى منتجات واجهة برمجة التطبيقات المرتبطة بالتطبيق.

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

وبالمثل، عندما يضيف مستخدم البوابة تطبيقًا أو يزيله أو يعدّله، ترسل البوابة التعديلات إلى Edge ليتم تخزينها.

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

  • إضافة تطبيق مطوِّر أو إزالته أو تعديله
  • الموافقة على مفتاح واجهة برمجة التطبيقات أو إبطاله لتطبيق مطوِّر برامج

لمزيد من المعلومات، اطّلِع على تسجيل التطبيقات وإدارة مفاتيح واجهة برمجة التطبيقات.

مكان تخزين معلومات حساب مطوِّر التطبيقات

يتم تخزين معلومات حساب المطوّر على Edge على النحو التالي:

يتم تخزين معلومات حساب المستخدم التالية على Edge:

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

عنوان البريد الإلكتروني هو المفتاح الأساسي الذي يستخدمه Edge لتحديد المطوّر ويجب أن يكون كل عنوان فريدًا. من المفتاح الأساسي، يُنشئ Edge معرّف مطوِّر فريدًا لكل مؤسسة ينتمي إليها المطوّر.

لمزيد من المعلومات، يُرجى الاطّلاع على تسجيل مطوّري التطبيقات.

مكان تخزين معلومات فريق المطوِّر (إصدار تجريبي)

عندما ينشئ مستخدم البوابة فريق المطوّرين على المنصة، يتم تخزين معلومات فريق المطوّرين على Edge، بما في ذلك:

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

يتم إنشاء عنوان بريد إلكتروني فريد يتم إنشاؤه تلقائيًا لفريق المطوّرين، ويكون هذا العنوان بمثابة المفتاح الأساسي الذي يستخدمه Edge لتحديد فريق المطوّرين.

لمزيد من المعلومات، يُرجى الاطّلاع على مشاركة المسؤولية عن تطبيق باستخدام فِرق مطوّري البرامج (إصدار تجريبي) وإدارة فِرق مطوّري البرامج.

لمحة عن نموذج البوابة

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

يُظهر ما يلي الصفحة الرئيسية لنموذج البوابة.

تتضمن صفحات البداية المتوفرة مع نموذج البوابة ما يلي:

الصفحة الوصف
الصفحة الرئيسية الصفحة الرئيسية للبوابة التي تصف واجهات برمجة التطبيقات المعروضة. يعمل كصفحة رئيسية افتراضية للمدخل (index.html). يوضح استخدام مكوّنات المواد الزاويّة، كما هو موضّح في مقالة إضافة مكوّنات المواد الزاويّة.
البدء بسرعة مجموعة من خطوات البدء السريع التي توضّح كيفية تخصيص البوابة. انقر على البدء السريع في نموذج البوابة للتعرُّف على خطوات إضافة المحتوى إلى صفحة البدء.
البدء نموذج لصفحة المحتوى يمكنك الاطّلاع على صفحة البدء في نموذج البوابة لمعرفة كيفية تعديل هذه الصفحة وإضافتها إلى شريط التنقّل العلوي.
واجهات برمجة التطبيقات قائمة بواجهات برمجة التطبيقات المتاحة عند إنشاء مستندات مرجعية تفاعلية لواجهة برمجة التطبيقات، تتم إضافة روابط إلى المحتوى في هذه الصفحة تلقائيًا.

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

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

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

المتصفحات المتوافقة

تتوافق بوابات Apigee المتكاملة مع إصدارات المتصفّح نفسها مثل Apigee Edge.