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

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

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

مقدمة

يوفر تسجيل التطبيق الآلية الأساسية للتحكم في الأشخاص الذين يمكنهم الوصول إلى واجهات برمجة التطبيقات.

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

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

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

توضّح الأقسام التالية كيفية تسجيل التطبيقات وإدارة مفاتيح واجهة برمجة التطبيقات باستخدام واجهة المستخدم وAPI.

استكشاف صفحة "التطبيقات"

ادخل إلى صفحة "التطبيقات" واستكشفها، كما هو موضّح أدناه.

Edge

للوصول إلى صفحة التطبيقات باستخدام واجهة مستخدم Edge:

  1. سجِّل الدخول إلى apigee.com/edge.
  2. اختَر نشر > التطبيقات في شريط التنقّل الأيمن.

وسيتم عرض صفحة "التطبيقات".

كما هو موضح في الشكل، تتيح لك صفحة "التطبيقات" ما يلي:

كلاسيكي Edge (السحابة الإلكترونية الخاصة)

للوصول إلى صفحة التطبيقات باستخدام واجهة مستخدم Edge الكلاسيكي:

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث يشير ms-ip إلى عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. اختَر نشر > تطبيقات المطوّرين في شريط التنقّل العلوي.

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

تسجيل تطبيق

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

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

تتم إضافة التطبيقات المسجَّلة إلى:

لتسجيل تطبيق في Edge:

  1. ادخل إلى صفحة "التطبيقات".
  2. انقر على + تطبيق.
  3. حدِّد تفاصيل التطبيق:
    الحقل الوصف مطلوب؟
    الاسم اسم التطبيق، ولا يمكنك تغيير الاسم بعد إنشائه. يُستخدم هذا الاسم في طلبات البيانات من واجهة برمجة التطبيقات الخاصة بالإدارة. نعم
    الاسم المعروض الاسم المعروض للتطبيق الذي يظهر في واجهة مستخدم إدارة Edge وبوابة المطوّرين. لا
    الشركة/المطوّر

    ملاحظة: لا يتوافق نظام Apigee المختلط مع تطبيقات الشركة، وهذا الحقل لا ينطبق.

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

    نعم
    عنوان URL لرد الاتصال يحدِّد عادةً عنوان URL لتطبيق تم تعيينه لتلقّي رمز تفويض نيابةً عن تطبيق العميل. هذه القيمة غير مطلوبة لجميع منتجات واجهة برمجة التطبيقات. لا
    Notes ملاحظات وصفية عن التطبيق لا
  4. حدِّد بيانات الاعتماد، بما في ذلك تاريخ انتهاء صلاحية مفتاح واجهة برمجة التطبيقات وحالته ومنتجات واجهة برمجة التطبيقات المقترنة.
    في قسم "بيانات الاعتماد"، انقر على وأدخِل المعلومات التالية:
    الحقل الوصف
    انتهاء الصلاحية اضبط مدة أو تاريخ انتهاء الصلاحية، أو اضبط مفتاح واجهة برمجة التطبيقات على ألا تنتهي صلاحيته أبدًا، وانقر على حسنًا.
    المنتجات اربط منتجًا واحدًا أو أكثر من منتجات واجهة برمجة التطبيقات بمفتاح واجهة برمجة التطبيقات:
    1. انقر على إضافة منتج.
    2. اختَر منتجًا واحدًا أو أكثر من منتجات واجهة برمجة التطبيقات من القائمة.
    3. انقر على إضافة.
    4. اضبط الحالة على "موافَق عليه" أو "تم إبطاله" لكل منتج من منتجات واجهة برمجة التطبيقات.
    5. كرِّر الخطوات لإضافة المزيد من منتجات واجهة برمجة التطبيقات.
  5. حدِّد السمات المخصّصة:
    1. في قسم السمات المخصّصة، انقر على .
    2. أدخِل الاسم والقيمة.
    3. انقر على إضافة أو إضافة وبدء آخر.
      الحد الأقصى لعدد السمات المخصّصة التي يمكنك إضافتها هو 18.
  6. انقر على إنشاء.

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

عرض التطبيقات المسجَّلة لمطوِّر برامج

للاطّلاع على التطبيقات المسجَّلة لمطوّر محدّد، استخدِم إحدى الطرق التالية:

عرض تطبيق وتعديله

لعرض تطبيق وتعديله:

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

إدارة بيانات الاعتماد

عند تعديل تطبيق، يمكنك إدارة بيانات اعتماده في قسم بيانات الاعتماد، كما هو موضح في الشكل التالي:

كما هو موضح في الشكل السابق، في قسم بيانات الاعتماد يمكنك إجراء المهام التالية باستخدام واجهة المستخدم:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. ادخل إلى صفحة "التطبيقات".
  2. انقر على صف التطبيق الذي تريد عرضه وتعديله.
  3. انقر على تعديل.
  4. انقر على بجانب منتج واجهة برمجة التطبيقات.
  5. انقر على حفظ.

يمكنك إعادة إضافة منتج تمّت إزالته.

جارٍ إنشاء بيانات اعتماد جديدة

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

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

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

الموافقة على تطبيق أو إبطاله

.

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

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

للموافقة على تطبيق أو إبطاله:

  1. ادخل إلى صفحة "التطبيقات".
  2. انقر على صف التطبيق الذي تريد عرضه وتعديله.
  3. انقر على تعديل.
  4. حدد موافقة أو إبطال في حقل حالة التطبيق للموافقة على التطبيق أو إبطاله، على التوالي.
  5. انقر على حفظ.

حذف تطبيق

عند حذف تطبيق، تصبح جميع مفاتيح العميل المرتبطة بالتطبيقات غير صالحة. يؤدي استخدام مفتاح غير صالح في الطلب إلى تعذّر تنفيذ الطلب.

إذا كنت تعتقد أنك قد تريد استعادة تطبيق مطوِّر البرامج في المستقبل، يمكنك بدلاً من الحذف إبطال التطبيق.

لحذف تطبيق:

  1. ادخل إلى صفحة "التطبيقات".
  2. ضع المؤشر في صف التطبيق الذي تريد حذفه.
  3. انقر على في عمود الإجراءات.

ملاحظة: في Apigee Edge for Public Cloud، يتم حذف تطبيق المطوّر والعناصر المرتبطة به بشكل غير متزامن. يتم حذف التطبيق الخاص بالمطوّر على الفور، ولكن يمكن أن يستغرق حذف الموارد المرتبطة بهذا التطبيق تلقائيًا، مثل مفاتيح التطبيق أو رموز الدخول، مدة تتراوح بين بضع ثوانٍ وبضع دقائق.

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

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

راجِع أيضًا استيراد مفاتيح وأسرار المستهلك الحالية.