كيفية تفاعل مطوّري التطبيقات مع بوابتك (الإصدار الأصلي)

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

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

توضّح الأقسام التالية كيفية تفاعل مطوّري التطبيقات مع البوابة:

كيفية تتبُّع تسجيل مطوّري التطبيق وتسجيل الدخول إليه في Edge

يتم تتبُّع تسجيل المطوّر وتسجيل الدخول إلى البوابة باستخدام السمة المخصّصة _apiportal في Edge.

عندما يسجّل المطوّر نفسه، تتم إضافة السمة _apiportal المخصّصة إلى إعدادات المطوّر ويتم ضبط حالة المطوّر على unverified للإشارة إلى أنّ المطوّر لم يسجّل الدخول إلى المنصة. مثال: {"status":"unverified","portals":{}}

في المرة الأولى التي يسجّل فيها المطوّر الدخول إلى بوابة، يتم تعديل السمة المخصّصة _apiportal لتتبُّع اسم البوابة ووقت الدخول، وضبط حالة المطوّر على active. في كل مرة يسجِّل فيها المطوّر الدخول إلى البوابة، يتم تعديل السمة المخصّصة لإعادة ضبط قيمة lastVisit (بتنسيق الحقبة) لتلك البوابة. مثال: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

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

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

عندما يسجّل مطوّر برامج في بوابة الويب الخاصة بك:

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

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

  1. انتقِل إلى البوابة.
  2. انقر على تسجيل الدخول.
  3. انقر على اشتراك.
    سيظهر مربّع الحوار التالي.

    إنشاء حساب

  4. أدخِل المعلومات المطلوبة (الاسم الأول واسم العائلة وعنوان البريد الإلكتروني).

  5. انقر على إنشاء.
    سيظهر مربّع الحوار التالي.

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

  6. انقر على الرابط الآمن في الرسالة الإلكترونية لفتح البوابة وإنشاء الجلسة التي تمت المصادقة عليها.

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

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

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

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

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

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

  5. انقر على الرابط الآمن في الرسالة الإلكترونية لفتح البوابة وإنشاء الجلسة التي تمت المصادقة عليها.

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

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

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

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

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

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

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

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

  5. انقر على طلب لطلب الموافقة على منتج واجهة برمجة تطبيقات غير مسموح به بعد.

  6. انقر على حفظ.

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

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

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

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

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

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

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

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

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

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

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

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

يمكن لمطوّري التطبيقات تعديل تفاصيل التطبيق على النحو التالي:

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

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

حذف تطبيق

يمكن لمطوّري التطبيقات حذف تطبيق من بوابة الويب الخاصة بك، كما يلي:

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

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