OAuth 2.0: ضبط خادم وكيل جديد لواجهة برمجة التطبيقات

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

إذا كنت تستخدم إصدار Apigee Cloud من Edge، ستلاحظ أنّه يتم تضمين خادم وكيل باسم oauth في مؤسستك تلقائيًا. يوفّر هذا الخادم الوكيل نقطتَي نهاية نموذجيتَين لإنشاء رموز الدخول ورموز إعادة التحميل. إذا أردت معرفة المزيد عن نقاط نهاية رموز OAuth المميزة، يمكنك الاطّلاع على التعرّف على نقاط نهاية OAuth.

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

إضافة بروتوكول OAuth 2.0 إلى خادم وكيل جديد لواجهة برمجة التطبيقات

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

Edge

لإضافة عملية التحقّق من OAuth إلى واجهة برمجة تطبيقات باستخدام واجهة مستخدم Edge، اتّبِع الخطوات التالية:

  1. سجِّل الدخول إلى apigee.com/edge.
  2. انقر على تطوير > خوادم وكيلة لواجهة برمجة التطبيقات في شريط التنقّل الأيمن.
  3. انقر على + خادم وكيل.
  4. استخدِم معالج "إنشاء خادم وكيل" لإنشاء خادم وكيل عكسي. اطّلِع على إنشاء خادم وكيل بسيط لواجهة برمجة التطبيقات.
  5. في صفحة السياسات الشائعة ضمن المعالج، انقر على زر الاختيار بجانب OAuth v2.0.

Classic Edge (Private Cloud)

لإضافة عملية التحقّق من OAuth إلى واجهة برمجة تطبيقات باستخدام واجهة مستخدم Classic Edge، اتّبِع الخطوات التالية:

  1. سجِّل الدخول إلى http://ms-ip:9000، حيث ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة.
  2. انقر على واجهات برمجة التطبيقات > خوادم وكيلة لواجهات برمجة التطبيقات في شريط التنقّل العلوي.
  3. انقر على + خادم وكيل لواجهة برمجة التطبيقات
  4. استخدِم معالج "إنشاء خادم وكيل" لإنشاء خادم وكيل عكسي. اطّلِع على إنشاء خادم وكيل بسيط لواجهة برمجة التطبيقات.
  5. في صفحة الأمان ضمن المعالج، انقر على زر الاختيار بجانب OAuth الإصدار 2.0.

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

يُرجى العِلم أنّ مربّع الاختيار منتج Publish API يصبح قابلاً للتحديد ويتم اختياره تلقائيًا. ضَع علامة في هذا المربّع إذا أردت إنشاء منتج تلقائيًا عند إنشاء خادم وكيل جديد لواجهة برمجة التطبيقات. سيتم إنشاء المنتج الذي تم إنشاؤه تلقائيًا مع ربطه بخادم وكيل واجهة برمجة التطبيقات الجديد. إذا كان لديك منتج حالي تريد ربط واجهة برمجة التطبيقات الجديدة به، احرص على إزالة العلامة من مربّع الاختيار هذا حتى لا تنشئ منتجًا غير ضروري. للحصول على معلومات حول المنتجات، يُرجى الاطّلاع على ما هو منتج واجهة برمجة التطبيقات؟

العمل مع خادم وكيل OAuth التلقائي

يعرض خادم وكيل OAuth معرّف الموارد المنتظم (URI) لنقطة النهاية التالية:

/oauth/client_credential/accesstoken

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

تتوفّر نقطة نهاية الرمز المميّز التلقائية لبيانات اعتماد العميل على الشبكة على عنوان URL التالي:

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

على سبيل المثال، إذا كان اسم مؤسستك هو "apimakers"، سيكون عنوان URL كما يلي:

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

هذا هو عنوان URL الذي يطلبه المطوّرون للحصول على رموز الدخول.

استدعاء واجهة برمجة التطبيقات

عند استرداد رمز دخول، يمكنك استدعاء واجهة برمجة التطبيقات باستخدام عنوان Authorization ورمز حامل مميّز، كما يلي:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

راجِع أيضًا إثبات صحة رموز الدخول.