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

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

تتيح بوابة المطوِّرين، وهي ابتكارية، لمستخدمي البوابة إنشاء حساب مستخدم وتسجيل الدخول وإدارة التطبيقات التي ستستهلك واجهات برمجة التطبيقات.

توضّح الأقسام التالية كيفية تفاعل مستخدمي البوابة مع المنصة.

تسجيل الدخول إلى البوابة

توضّح الأقسام التالية كيفية تسجيل مستخدمي البوابة إلى المدخل المدمج باستخدام بيانات اعتماد المستخدم (موفِّر الهوية المضمَّن) أو باستخدام SAML (الإصدار التجريبي).

في حال تفعيل كل من موفِّري الهوية المدمَجين وSAML، سيتمكّن مستخدمو البوابة من اختيار طريقتهم المفضّلة لتسجيل الدخول.

تسجيل الدخول إلى البوابة باستخدام بيانات اعتماد المستخدم (موفِّر الهوية المضمَّن)

عند تفعيل موفّر الهوية المضمَّن، يمكن لمستخدمي البوابة تسجيل الدخول إلى المنصة المُدمجة باستخدام بيانات اعتماد المستخدم (اسم المستخدم وكلمة المرور)، كما هو موضَّح في الأقسام التالية:

إنشاء حساب مستخدم على البوابة المدمجة

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

يمكن لمستخدمي البوابة إنشاء حساب مستخدم على البوابة المدمجة على النحو التالي:

  1. انتقِل إلى البوابة.
  2. انقُر على تسجيل الدخول.

    ستظهر لك صفحة تسجيل الدخول.

  3. انقر على إنشاء حساب.

    يتم عرض صفحة "إنشاء حسابك".

    مربّع حوار إنشاء حسابك

  4. أكمل النموذج.

    يجب إدخال قيم لكل الحقول المطلوبة. يجب ألا تقل كلمات المرور عن 8 أحرف وأن تحتوي على واحد مما يلي على الأقل: الرقم والحرف الصغير والحرف الكبير والحرف الخاص.

  5. راجِع البنود ووافِق عليها.

  6. انقر على إنشاء حساب.

  7. أكمل نموذج CAPTCHA، وانقر على تحقق (إذا كان معروضًا).

    يتم إنشاء حساب المستخدم ويتم إرسال رسالة تأكيد إلكترونية.

  8. في غضون 10 دقائق، انقر على الرابط في رسالة التأكيد الإلكترونية لإكمال عملية التسجيل.

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

  9. تسجيل الدخول إلى البوابة المدمجة (على النحو الموضَّح أدناه)

تسجيل الدخول إلى البوابة المدمجة

باستخدام موفّر الهوية المضمَّن، بعد تسجيل مستخدمي البوابة على المنصة المدمَجة والموافقة عليها، يسجِّلون الدخول باستخدام بيانات الاعتماد (اسم المستخدم وكلمة المرور).

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

  1. انتقِل إلى البوابة.
  2. انقُر على تسجيل الدخول. تعرض صفحة تسجيل الدخول ما يلي: صفحة تسجيل الدخول
  3. أدخِل عنوان البريد الإلكتروني وكلمة المرور.
  4. انقُر على تسجيل الدخول.

تغيير كلمة المرور

باستخدام موفِّر الهوية المدمَج، يمكن لمستخدمي البوابة تغيير كلمة المرور على النحو التالي:

  1. انتقِل إلى البوابة.
  2. انقُر على تسجيل الدخول.
  3. انقر على إعادة ضبط كلمة المرور.
  4. أدخِل عنوان البريد الإلكتروني للحساب الذي تريد إعادة ضبطه.
  5. انقر على إرسال رابط إعادة ضبط كلمة المرور.

    يتم إرسال رابط إعادة ضبط كلمة المرور إلى الرسالة الإلكترونية.

  6. انقر على الرابط في رسالة التأكيد الإلكترونية.

  7. أدخِل كلمة المرور الجديدة وأكِّدها.

    يجب ألا تقل كلمات المرور عن 8 أحرف وأن تحتوي على واحد مما يلي على الأقل: الرقم والحرف الصغير والحرف الكبير والحرف الخاص.

  8. انقر على إنشاء كلمة مرور جديدة.

تسجيل الدخول إلى البوابة باستخدام مصادقة SAML (إصدار تجريبي)

عند تفعيل موفِّر هوية SAML، يسجِّل مستخدمو البوابة الدخول إلى البوابة المدمجة باستخدام مصادقة SAML، كما يلي:

  1. انتقِل إلى البوابة.
  2. انقُر على تسجيل الدخول.
  3. انقر على تسجيل الدخول باستخدام SAML.

    ستتم إعادة توجيهك إلى موفر SAML.

  4. أدخِل بيانات الاعتماد لموفِّر هوية SAML إذا طُلب منك ذلك.

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

يمكن لمستخدمي البوابة الاطّلاع على المستندات المرجعية لواجهة برمجة التطبيقات التي نشرتها على البوابة، وذلك على النحو التالي:

  1. انتقِل إلى البوابة.
  2. انقر على واجهات برمجة التطبيقات في شريط التنقّل العلوي. سيتم عرض صفحة واجهات برمجة التطبيقات. مثلاً:

    صفحة واجهات برمجة التطبيقات

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

  4. انقر على بطاقة واجهة برمجة التطبيقات للاطّلاع على المستندات المرجعية لواجهة برمجة التطبيقات. سيتم عرض المستندات المرجعية لواجهة برمجة التطبيقات.

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

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

تتيح فِرق المطوّرين لمستخدمي البوابة مشاركة المسؤولية عن أحد التطبيقات مع مستخدمي البوابة الآخرين. توضّح الأقسام التالية كيفية إنشاء فِرق مطوّري البرامج وإدارتها.

لمحة عن أدوار فريق المطوّرين

يلخص الجدول التالي الأدوار التي يمكن إسنادها لأعضاء فريق المطوّرين:

Role الوصف
مشرف التطبيق
  • امتيازات القراءة فقط لأعضاء فريق المطوّرين وتفاصيل فريق المطوّرين
  • امتيازات القراءة والكتابة للتطبيقات
المالك امتيازات القراءة والكتابة الكاملة لأعضاء فريق المطوّرين وتفاصيل فريق المطوّرين والتطبيقات
المُشاهد امتيازات للقراءة فقط لأعضاء فريق المطوّرين وتفاصيل فريق المطوّرين والتطبيقات

عرض صفحة الفِرق

تعرض صفحة "الفِرق" فِرق مطوّري البرامج التي أنت عضو فيها.

للوصول إلى صفحة Teams (الفرق):

  1. سجِّل الدخول إلى البوابة.
  2. اختَر الفِرق من القائمة المنسدلة لحساب المستخدم في البوابة.

يتم عرض صفحة الفرق التي تتيح لك:

إضافة فِرق مطوّري البرامج

لإضافة فريق مطوّر:

  1. سجِّل الدخول إلى البوابة.
  2. اختَر الفِرق من القائمة المنسدلة لحساب المستخدم في البوابة.
  3. انقر على + فريق جديد.
  4. أدخِل اسمًا ووصفًا.
  5. لإضافة عضو إلى فريق المطوّرين، انقر على + إضافة عضو آخر، وأدخِل عنوان البريد الإلكتروني لمستخدم البوابة، واختَر دور فريق المطوِّر.

    كرِّر هذه الخطوة لإضافة أعضاء آخرين.

  6. لحذف عضو من فريق المطوّرين، انقر على الرمز رمز الحذف بجانب عضو فريق المطوّرين الذي تريد حذفه.

  7. انقر على إنشاء.

تعديل عضوية فريق المطوّرين وأدوارهم

لتعديل عضوية فريق المطوّرين وأدوارهم:

  1. سجِّل الدخول إلى البوابة.
  2. اختَر الفِرق من القائمة المنسدلة لحساب المستخدم في البوابة.
  3. انقر على صفّ فريق المطوّرين الذي تريد تعديله والذي تملك حقوق الملكية له.
  4. نفِّذ خطوة أو أكثر من الخطوات التالية:

    • عدِّل الاسم والوصف جهة الاتصال الأساسية.
    • إضافة أعضاء فريق المطوِّرين أو إزالتهم
    • عدِّل أدوار أعضاء فريق المطوّرين.
  5. انقر على حفظ.

إزالة نفسك من فريق المطوِّرين

لإزالة نفسك من فريق المطوّرين، يُرجى اتّباع الخطوات التالية:

  1. سجِّل الدخول إلى البوابة.
  2. اختَر الفِرق من القائمة المنسدلة لحساب المستخدم في البوابة.
  3. انقر على صف فريق المطوّرين الذي تريد إزالة نفسك منه.
  4. انقر على مغادرة الفريق.

حذف فريق مطوّري البرامج

لحذف فريق المطوِّرين، يُرجى اتّباع الخطوات التالية:

  1. سجِّل الدخول إلى البوابة.
  2. اختَر الفِرق من القائمة المنسدلة لحساب المستخدم في البوابة.
  3. انقر على صف فريق المطوّرين الذي تريد حذفه.
  4. انقر على رمز الحذف
  5. انقر على تأكيد لتأكيد الحذف.

تسجيل التطبيقات

سجِّل تطبيقات المطوِّرين وتطبيقات فريق المطوِّرين، كما هو موضَّح في الأقسام التالية.

تسجيل تطبيقات المطوّرين

يمكن لمستخدمي البوابة تسجيل التطبيقات لاستخدام واجهات برمجة التطبيقات التي نشرتها، كما يلي:

  1. اختَر التطبيقات من القائمة المنسدلة لحساب المستخدم.
  2. انقر على + تطبيق جديد لإنشاء تطبيق جديد.
  3. أدخل اسمًا ووصفًا للتطبيق في مربع الحوار "تطبيق جديد".
  4. حدد مالك التطبيق في القائمة المنسدلة المالك.

    أنت مالك التطبيق تلقائيًا. وإذا أردت، يمكنك اختيار فريق من المطوّرين من القائمة المنسدلة لتقاسم مسؤولية التطبيق مع أعضاء فريق المطوّرين الآخرين. يُرجى الاطّلاع على مشاركة المسؤولية عن تطبيق باستخدام فِرق المطوّرين (إصدار تجريبي).

  5. في القسم "كتالوج واجهة برمجة التطبيقات"، اختَر واجهة برمجة تطبيقات واحدة أو أكثر.

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

  6. إذا اخترت واجهة برمجة تطبيقات في القسم "واجهات برمجة التطبيقات التي تمت مصادقتها"، أدخِل عنوان URL لمعاودة الاتصال.

    لمزيد من المعلومات، اطّلِع على مقالة لمحة عن عناوين URL لمعاودة الاتصال.

  7. انقر على إنشاء.

تسجيل تطبيقات فريق المطوّرين

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

لمزيد من المعلومات حول كيفية إجراء ذلك:

لتسجيل تطبيقات فريق المطوّرين:

  1. اختر الفرق من القائمة المنسدلة لحساب المستخدم.
  2. انقر على صف فريق المطوّرين الذي تريد تسجيل التطبيق فيه.
  3. انقر على + تطبيق جديد لإنشاء تطبيق جديد.
  4. أدخل اسمًا ووصفًا للتطبيق في مربع الحوار "تطبيق جديد".
  5. حدد مالك التطبيق في القائمة المنسدلة المالك.

    بشكل تلقائي، يكون فريق المطوّرين هو مالك التطبيق. ويمكنك اختيار فريق مطوِّر آخر أو اختيار نفسك كمالك من القائمة المنسدلة إذا أردت ذلك.

  6. في القسم "كتالوج واجهة برمجة التطبيقات"، اختَر واجهة برمجة تطبيقات واحدة أو أكثر.

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

  7. إذا اخترت واجهة برمجة تطبيقات في القسم "واجهات برمجة التطبيقات التي تمت مصادقتها"، أدخِل عنوان URL لمعاودة الاتصال.

    لمزيد من المعلومات، اطّلِع على مقالة لمحة عن عناوين URL لمعاودة الاتصال.

  8. انقر على إنشاء.

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

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

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

يمكن لمستخدمي البوابة إدارة واجهات برمجة التطبيقات في أحد التطبيقات من البوابة، كما يلي:

  1. اختَر التطبيقات من القائمة المنسدلة لحساب المستخدم.
  2. انقر على التطبيق في القائمة.
  3. في قسم واجهات برمجة التطبيقات، انقر على رمز التفعيل أو رمز الإيقاف لتفعيل الوصول إلى واجهة برمجة التطبيقات من التطبيق أو إيقافه.
  4. بالنسبة إلى واجهة برمجة التطبيقات التي تمت مصادقتها، يمكنك إضافة عنوان URL لمعاودة الاتصال أو تعديله، حسب الحاجة.

عرض مفتاح وسر واجهة برمجة التطبيقات لأحد التطبيقات

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

  1. اختَر التطبيقات من القائمة المنسدلة لحساب المستخدم.
  2. انقر على التطبيق في القائمة.
  3. يمكنك الاطّلاع على مفاتيح واجهة برمجة التطبيقات في قسم "مفاتيح واجهة برمجة التطبيقات".
  4. تأكَّد من أنّ حالة مفتاح واجهة برمجة التطبيقات "نشط". إذا كان مفتاح واجهة برمجة التطبيقات يتطلّب الحصول على موافقة ولم تتم الموافقة عليه بعد، ستظهر الحالة بالحالة في انتظار الموافقة.
  5. انقر على إظهار السر لعرض الرمز السرّي.
  6. ضع مؤشر الماوس فوق مفتاح واجهة برمجة التطبيقات أو المفتاح السري وانقر على رمز الحذف لنسخه إلى الحافظة.

تدوير مفتاح واجهة برمجة التطبيقات لأحد التطبيقات

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

يمكن لمستخدمي البوابة تغيير مفتاح واجهة برمجة التطبيقات لأحد التطبيقات من البوابة، وذلك على النحو التالي:

  1. اختَر التطبيقات من القائمة المنسدلة لحساب المستخدم.
  2. انقر على التطبيق في القائمة.
  3. في قسم "مفاتيح واجهة برمجة التطبيقات"، انقر على إضافة مفتاح.
  4. انقر على تأكيد في مربّع الحوار لتأكيد العملية.
  5. يمكنك اختياريًا إبطال مفتاح واجهة برمجة التطبيقات القديم، كما هو موضّح أدناه.

إبطال مفتاح واجهة برمجة التطبيقات لتطبيق

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

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

  1. اختَر التطبيقات من القائمة المنسدلة لحساب المستخدم.
  2. انقر على اسم التطبيق.
  3. في قسم "مفاتيح واجهة برمجة التطبيقات"، انقر على رمز الإبطال في عمود "الإجراءات" المرتبط بمفتاح واجهة برمجة التطبيقات الذي تريد إبطاله.
  4. انقر على تأكيد لتأكيد العملية.

    يتم تعديل حالة المفتاح إلى "تم الإبطال".

تعديل تفاصيل التطبيق

يمكن لمستخدمي البوابة تعديل تفاصيل التطبيق على النحو التالي:

  1. اختَر التطبيقات من القائمة المنسدلة لحساب المستخدم.
  2. انقر على التطبيق في القائمة.
  3. عدِّل الحقلين "الاسم" أو "الوصف" في علامة التبويب "تفاصيل التطبيق".
  4. إدارة واجهات برمجة التطبيقات في التطبيق، كما هو مطلوب.
  5. انقر على حفظ.

حذف تطبيق

يمكن لمستخدمي البوابة حذف تطبيق من المنصة على النحو التالي:

  1. اختَر التطبيقات من القائمة المنسدلة لحساب المستخدم.
  2. انقر على التطبيق في القائمة.
  3. انقر على حذف.
  4. انقر على تأكيد لتأكيد العملية.

يتم حذف التطبيق وإزالته من قائمة التطبيقات.