أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
توفّر Apigee Edge بوابة متكاملة وسهلة الاستخدام لتوثيق إمكانية الوصول إلى واجهات برمجة التطبيقات وإدارتها، وتعزيز منتدى مطوّري التطبيقات.
يمكن لجميع مستخدمي Apigee Edge الوصول إلى أدوات تطوير البوابة المتكاملة التي تتيح لهم إنشاء بوابة المطوّرين الخاصة بهم بسرعة، ما يقدّم بديلاً عن تطوير البوابة المستندة إلى Drupal. للاطّلاع على مقارنة الميزات، يُرجى الاطّلاع على مقارنة ميزات "بوابة المطوّرين".
شاهِد هذا الفيديو القصير للحصول على مقدمة عن إنشاء البوابة المدمجة ونشرها.
الميزات والمزايا الرئيسية
تقدّم لك البوابة المدمجة الميزات والمزايا الرئيسية التالية:الميزة | المزايا |
---|---|
تطوير محتوى البوابة | يمكنك تطوير محتوى البوابة بسرعة وسهولة.
|
مظهر البوابة وأسلوبها | تخصيص مظهر البوابة وأسلوبها بالكامل باستخدام أوراق الأنماط SCSS والعلامة التجارية المخصّصة |
مستند واجهة برمجة التطبيقات | إنشاء مستندات مرجعية لواجهات برمجة التطبيقات تلقائيًا استنادًا إلى مواصفات OpenAPI |
التسجيل الذاتي | يمكنك توفير خدمة تسجيل ذاتي للمطوّرين حتى يتمكّنوا من إنشاء تطبيقات باستخدام واجهات برمجة التطبيقات. |
إدارة الجمهور | التحكّم في المستخدمين الذين يمكنهم الوصول إلى محتوى البوابة وواجهات برمجة التطبيقات |
الإحصاءات | ضبط "إحصاءات Google" وتتبُّع الإحصاءات المخصّصة |
تخصيصات متقدّمة | إجراء تخصيصات متقدّمة للبوابة، بما في ذلك:
|
بدء إنشاء البوابة
كيفية تعامل Apigee مع الأمان في البوابة المدمجة
يوضّح الجدول التالي كيفية معالجة Apigee للأمان من خلال الميزات المضمّنة في البوابة المتكاملة.
الميزة | العناوين |
---|---|
يتطلب بروتوكول HTTPS وأمان طبقة النقل (TLS) | فرض الاتصالات المشفَّرة |
يشمل تسجيل النطاق apigee.io من خلال قائمة اللاحقات العلنية
|
لا يسمح بضبط "ملفات تعريف الارتباط الفائقة" على النطاقات الفرعية من apigee.io
|
تتيح ضبط سياسة أمان المحتوى (CSP) | الحماية من هجمات البرمجة عبر المواقع (XSS) وغيرها من هجمات حقن الرموز البرمجية |
المتطلّبات:
|
الحماية من هجمات حقن HTML أو SQL أو الخلفية |
يتضمّن x-content-type-options: nosniff عنوان XSS
|
لا يسمح للمتصفّحات بمحاولة تخمين أنواع MIME |
يتضمّن x-frame-options: deny عنوان XSS
|
لا يسمح بتضمين محتوى البوابة في إطار iFrame |
يتضمّن x-xss-protection: 1 عنوان XSS
|
يمنع تحميل الصفحات عند رصد هجمات البرمجة عبر المواقع (XSS) المنعكسة |
استخدام الرموز المميّزة لهجوم CSRF | الحماية من تزوير الطلبات من مواقع إلكترونية مختلفة |
نقاط القوة:
|
إجراءات حماية بيانات العملاء |
كيفية تواصل البوابة المتكاملة مع Edge
يتم تخزين معظم المعلومات التي تستخدمها بوابة المطوّرين على Apigee Edge. تعمل البوابة كعميل لخدمة Edge. تُرسِل بوابة المطوّرين طلبًا عبر HTTP أو HTTPS REST لاسترداد المعلومات من Edge أو إرسالها إليه حسب الحاجة. على سبيل المثال، عندما يسجِّل مستخدم البوابة تطبيقًا جديدًا على البوابة، تُرسِل البوابة طلبًا إلى Edge لتخزين معلومات عن التطبيق.
تقدّم الأقسام التالية مزيدًا من التفاصيل.
مكان تخزين تسجيل التطبيق ومفاتيح واجهة برمجة التطبيقات
عندما يُكمل أحد مستخدمي البوابة عملية تسجيل التطبيق على البوابة المدمجة، تُرسِل البوابة معلومات عن التطبيق إلى Apigee Edge، بما في ذلك اسم التطبيق ومنتجات واجهة برمجة التطبيقات المرتبطة بالتطبيق. وإذا سجّلت Edge التطبيق بنجاح، ستُرسِل Edge مفتاح واجهة برمجة تطبيقات واحدًا إلى البوابة. يستخدم مستخدم البوابة مفتاح واجهة برمجة التطبيقات هذا للوصول إلى منتجات واجهة برمجة التطبيقات المرتبطة بالتطبيق.
يتم تخزين معلومات التطبيقات ومفاتيح واجهة برمجة التطبيقات على Edge فقط، ولا يتم تخزينها على البوابة. عندما يستخدم مستخدم البوابة البوابة لعرض معلومات عن تطبيق، مثلاً من خلال صفحة "تطبيقاتي"، تُرسل البوابة طلبًا إلى Edge باستخدام مفتاح واجهة برمجة التطبيقات للوصول إلى المعلومات.
وبالمثل، عندما يضيف مستخدم البوابة تطبيقًا أو يزيله أو يعدّله، تُرسِل البوابة التعديلات إلى Edge لتتم تخزينها.
بما أنّه يتم تخزين جميع المعلومات عن التطبيقات ومفاتيح واجهة برمجة التطبيقات على Edge، يمكن لمشرف Edge تعديل المعلومات باستخدام واجهة برمجة التطبيقات أو واجهة برمجة التطبيقات لإدارة Edge. على سبيل المثال، يمكن للمشرف إجراء ما يلي:
- إضافة تطبيق مطوّر أو إزالته أو تعديله
- الموافقة على مفتاح واجهة برمجة تطبيقات أو إبطاله لتطبيق مطوّر
لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تسجيل التطبيقات وإدارة مفاتيح واجهة برمجة التطبيقات.
مكان تخزين معلومات حساب مطوّر التطبيق
يتم تخزين معلومات حساب المطوّر على Edge على النحو التالي:
- باستخدام مزوّد الهوية المضمّن، عندما ينشئ مستخدم البوابة حسابًا، يتم تخزين المعلومات في مزوّد الهوية وعرضها في صفحة "المستخدمون".
- باستخدام موفِّر هوية SAML، عندما يسجل مستخدم البوابة الدخول إلى البوابة، يتم تخزين سجلّ احتياطي للمعلومات في موفِّر الهوية ويتم عرضه في صفحة "المستخدِمون".
- بعد أن يُسجِّل مستخدم البوابة تطبيق مطوِّر، تتم مزامنة معلومات حساب المستخدم مع Edge وتكون متاحة في صفحة المطوّرين.
يتم تخزين معلومات حساب المستخدم التالية على Edge:
- الاسم الأول واسم العائلة
- عنوان البريد الإلكتروني
- اسم المستخدم
- حالة حساب البوابة (نشط أو غير نشط)
- دور البوابة (مستخدم تمّت مصادقة هويته أو مشرف أو غير ذلك)
- الأذونات المستندة إلى الأدوار
- الفِرق التي يكون مستخدم البوابة عضوًا فيها (في حال التسجيل في الإصدار التجريبي من ميزة الفِرق)
عنوان البريد الإلكتروني هو المفتاح الأساسي الذي يستخدمه Edge لتحديد المطوِّر، ويجب أن يكون كل عنوان فريدًا. من المفتاح الأساسي، ينشئ Edge معرّف مطوّر فريدًا لكل مؤسسة ينتمي إليها المطوّر.
لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تسجيل مطوّري التطبيقات.
مكان تخزين معلومات فريق المطوّرين (إصدار تجريبي)
عندما ينشئ مستخدم البوابة فريق مطوّرين على البوابة، يتم تخزين معلومات فريق المطوّرين على Edge، بما في ذلك:
- اسم فريق المطوّرين ووصفهم
- أعضاء فريق المطوّرين وأدوارهم
- التطبيقات التي تم تعيين فريق المطوّرين لها
- شرائح الجمهور التي تمّ تعيينها لفريق المطوّرين
- وقت إنشاء فريق المطوّرين
يتم إنشاء عنوان بريد إلكتروني فريد يتم إنشاؤه تلقائيًا لفريق المطوّرين، ويكون بمثابة المفتاح الأساسي الذي يستخدمه Edge لتحديد فريق المطوّرين.
لمزيد من المعلومات، يُرجى الاطّلاع على المقالتَين مشاركة مسؤولية تطبيق باستخدام فِرق المطوّرين (إصدار تجريبي) وإدارة فِرق المطوّرين.
لمحة عن نموذج البوابة
عند إنشاء بوابة جديدة، يتم توفير مجموعة من الصفحات المبدئية لاستخدامها كنقطة انطلاق. تحتوي الصفحات المبدئية على محتوى تجريبي للمساعدة في إلهام تطوير البوابة الخاصة بك عند استبدال النصوص والصور بمحتوى فريد من نوعه. يستخدم نموذج مظهر البوابة مظهر التصميم المتعدد الأبعاد وSCSS.
يعرض ما يلي الصفحة الرئيسية نموذج البوابة.
تشمل الصفحات الأساسية المقدَّمة مع نموذج البوابة ما يلي:
الصفحة | الوصف |
---|---|
الصفحة الرئيسية | الصفحة الرئيسية للبوابة التي تصف واجهات برمجة التطبيقات المعروضة تُستخدَم كصفحة رئيسية تلقائية لبوابتك (index.html). توضِّح كيفية استخدام مكونات Angular Material، كما هو موضّح في مقالة إضافة مكونات Angular Material. |
البدء بسرعة | مجموعة من خطوات البدء السريع التي توضّح كيفية تخصيص البوابة انقر على البدء السريع في نموذج البوابة للاطّلاع على خطوات إضافة المحتوى إلى صفحة البدء. |
البدء | نموذج لصفحة محتوى اطّلِع على صفحة البدء في نموذج البوابة الإلكترونية للتعرّف على كيفية تعديل هذه الصفحة وإضافتها إلى شريط التنقّل العلوي. |
واجهات برمجة التطبيقات | قائمة واجهات برمجة التطبيقات المتاحة عند إنشاء مستندات مرجعية تفاعلية لواجهة برمجة التطبيقات، تتم إضافة روابط إلى المحتوى في هذه الصفحة تلقائيًا. ملاحظة: يتم إنشاء محتوى هذه الصفحة تلقائيًا استنادًا إلى واجهات برمجة التطبيقات التي تنشرها في البوابة. لا يمكنك تعديل محتوى هذه الصفحة مباشرةً، فهي لا تظهر في قائمة الصفحات. يمكنك تعديل تصميم الصفحة باستخدام محرر مظهر البوابة. |
تطبيقاتي | قائمة بالتطبيقات المسجَّلة لمستخدم مفوَّض اطّلِع على كيفية تفاعل مستخدمي البوابة مع البوابة. ملاحظة: يتم إنشاء محتوى هذه الصفحة تلقائيًا استنادًا إلى تطبيقات المستخدمين المسجّلين. لا يمكنك تعديل محتوى الصفحة مباشرةً، فهي لا تظهر في قائمة الصفحات. يمكنك تعديل تصميم الصفحة باستخدام أداة تعديل المظهر. |
تسجيل الدخول | صفحة تسجيل الدخول للمستخدمين المسجّلين يمكن للمستخدمين الجدد التسجيل من هذه الصفحة بالنقر على تسجيل الدخول. اطّلِع على كيفية تفاعل مستخدمي البوابة مع البوابة. ملاحظة: يتم تضمين صفحة "تسجيل الدخول" في البوابة تلقائيًا. يمكنك تخصيص الشعار في صفحة "تسجيل الدخول" وإضافة حقول تسجيل مخصّصة إلى صفحة "إنشاء حساب". لا يمكنك تعديل محتوى الصفحة مباشرةً، فهي لا تظهر في قائمة الصفحات. |
الأحكام والشروط | نموذج لصفحة الأحكام والشروط |
دعم المتصفح
تتوافق البوابات المدمجة في Apigee مع إصدارات المتصفّح نفسها المتوافقة مع Apigee Edge.