يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات
Apigee X. المعلومات
مفتاح واجهة برمجة التطبيقات (المعروف في Apigee Edge باسم مفتاح المستهلك) هو قيمة سلسلة يتم تمريرها من خلال تطبيق العميل إلى الخوادم الوكيلة لواجهة برمجة التطبيقات. ويحدِّد المفتاح تطبيق العميل بشكلٍ فريد.
إنّ التحقّق من صحة مفتاح واجهة برمجة التطبيقات هو أبسط أشكال الأمان المستند إلى التطبيقات التي يمكنك ضبطها لواجهة برمجة تطبيقات. يقدم تطبيق العميل ببساطة مفتاح واجهة برمجة التطبيقات مع طلبه، ثم يتحقق Apigee Edge للتأكد من أن مفتاح واجهة برمجة التطبيقات في حالة تمت الموافقة عليها للمورد المطلوب. داخليًا، يستخدم الخوادم الوكيلة السياسات للتحقق من صحة مفتاح واجهة برمجة التطبيقات.
لتوفير هذه البساطة، ستحتاج إلى إجراء بعض الإعداد. لإتاحة استخدام مفاتيح واجهة برمجة التطبيقات، عليك تنفيذ ما يلي:
- أنشِئ منتج واجهة برمجة تطبيقات Apigee Edge يدمج الخوادم الوكيلة لواجهة برمجة التطبيقات التي تريد حمايتها باستخدام مفتاح واجهة برمجة التطبيقات.
-
أنشئ تطبيق مطوّر Apigee Edge يمثِّل مطوّر تطبيق العميل الذي ستتم مصادقة تطبيقه.
عند إنشاء التطبيق الخاص بالمطوّر، يجب أن تحدّد منتجات واجهة برمجة التطبيقات التي سيتمكّن التطبيق الخاص بها من الوصول إليها، والذي سيحتاج إلى توفير مفتاح واجهة برمجة تطبيقات لها.
- إلى الخوادم الوكيلة (أي الخوادم التي ضمّنتها في منتج واجهة برمجة التطبيقات)، عليك إضافة سياسات للتحقّق من صلاحية مفتاح واجهة برمجة التطبيقات الوارد.
يقدّم البرنامج التعليمي تأمين واجهة برمجة التطبيقات من خلال طلب مفاتيح واجهة برمجة التطبيقات طريقة سريعة للتعرّف على كيفية التحكّم في إمكانية الوصول إلى خادم وكيل لواجهة برمجة التطبيقات باستخدام مفتاح واجهة برمجة التطبيقات.
آلية عمل مفاتيح واجهة برمجة التطبيقات
في Apigee Edge، يُشار إلى مفتاح واجهة برمجة التطبيقات باسم مفتاح العميل. عند تسجيل تطبيقات مطوّري البرامج، ينشئ Apigee Edge مفتاح وسر للعميل. يخزِّن Apigee Edge مفتاح المستهلك للتحقّق من صحته في المستقبل. يُعدّ كل مفتاح عميل فريدًا في المؤسسة. يُضمِّن مطوّر التطبيقات مفتاح المستهلك في تطبيق العميل. ويجب أن يعرض تطبيق العميل مفتاح المستهلك لكل طلب. تتحقّق خدمات واجهة برمجة التطبيقات من مفتاح المستهلك قبل السماح بطلب التطبيق.
الخطوات عالية المستوى
توضّح الخطوات التالية كيفية استخدام Apigee Edge لمفاتيح واجهة برمجة التطبيقات. تتضمّن هذه الخطوات إمكانية توفُّر أمان OAuth أيضًا، لأنّه غالبًا ما يتم استخدامه مع مفاتيح واجهة برمجة التطبيقات.
- أنشئ منتج واجهة برمجة التطبيقات الذي يتضمن الخوادم الوكيلة لواجهة برمجة التطبيقات التي يجب حمايتها باستخدام مفتاح واجهة برمجة التطبيقات.
- يمكنك تسجيل تطبيق مطوِّر في مؤسستك. في أثناء تنفيذ Apigee Edge، تنشئ ميزة Apigee Edge مفتاح العميل وسر العميل.
- اربط تطبيق المطوِّر بمنتج واحد على الأقل لواجهة برمجة التطبيقات. وهو المنتج الذي يربط مسارات الموارد والخوادم الوكيلة لواجهة برمجة التطبيقات بالموافقة على المفاتيح.
- في وقت التشغيل، عندما يقدّم تطبيق العميل طلبًا إلى واجهة برمجة التطبيقات، يُرسل التطبيق العميل
مفتاح العميل عند تقديم الطلب. من الناحية العملية، قد يتم
تمرير مفتاح المستهلك بشكل صريح أو قد تتم الإشارة إليه ضمنيًا عبر رمز OAuth المميز:
- إذا كانت واجهة برمجة التطبيقات تستخدم ميزة التحقّق من مفتاح واجهة برمجة التطبيقات، مثلاً من خلال تنفيذ سياسة التحقّق من واجهة برمجة التطبيقات، يجب أن يمرر تطبيق العميل مفتاح العميل صراحةً.
- عندما تستخدم واجهة برمجة التطبيقات ميزة التحقّق من رمز OAuth المميّز، مثل تنفيذ سياسة OAuthV2، يجب أن يمرّر تطبيق العميل رمزًا مميّزًا تم الحصول عليه من مفتاح المستهلك.
- يتحقق الخادم الوكيل لواجهة برمجة التطبيقات من بيانات اعتماد الطلب من خلال سياسة التحقّق من APIKey أو سياسة OAuthV2 باستخدام عملية التحقّق من الوصول. في حال عدم تضمين سياسة فرض بيانات الاعتماد في الخادم الوكيل لواجهة برمجة التطبيقات، يمكن لأي متصل استدعاء واجهات برمجة التطبيقات بنجاح. للمزيد من المعلومات، يُرجى الاطّلاع على سياسة التحقّق من مفتاح واجهة برمجة التطبيقات.
جارٍ التحقق من بيانات اعتماد طلب
هذه نظرة عامة. احرص على الاطّلاع على إعداد التحقق من مفتاح واجهة برمجة التطبيقات للحصول على تفاصيل وأمثلة على الرموز.
- إذا كنت تستخدم رمز OAuth المميّز، يعني ذلك أنّك نفّذت سياسة OAuth للتحقّق
ومرِّر تطبيق العميل رمز OAuth مميز:
- يتحقّق Apigee Edge من عدم انتهاء صلاحية الرمز المميّز، ثم يبحث عن مفتاح العميل الذي تم استخدامه لإنشاء الرمز المميّز.
- إذا كنت تستخدم مفتاح واجهة برمجة التطبيقات، تكون قد نفذت سياسة التحقّق من واجهة برمجة التطبيقات ومرِّر تطبيق العميل مفتاح المستهلك:
- يتحقّق Apigee Edge من قائمة منتجات واجهة برمجة التطبيقات التي تم ربط مفتاح المستهلك بها.
- يتحقّق Edge من كل منتج من منتجات واجهة برمجة التطبيقات لمعرفة ما إذا كان الخادم الوكيل الحالي لواجهة برمجة التطبيقات مضمَّنًا في منتج واجهة برمجة التطبيقات، وما إذا كان مسار المورد الحالي (مسار عنوان URL) مفعَّلاً في منتج واجهة برمجة التطبيقات.
- يتحقّق Edge أيضًا من عدم انتهاء صلاحية مفتاح المستهلك أو إبطاله، ويتحقّق من عدم إبطال التطبيق، ويتحقّق من أنّ المطوّر ليس نشطًا.
- وإذا توفرت جميع هذه الشروط، أي لم تنتهِ صلاحية الرمز المميّز (إذا كان ذلك منطبقًا)، سيكون مفتاح المستهلك صالحًا وتمت الموافقة عليه، وتمت الموافقة على التطبيق، ومطوّر التطبيق نشطًا، وأنّ الخادم الوكيل متوفّر في المنتج، والمورد متاحًا على المنتج، وستكون عملية إثبات صحة بيانات الاعتماد بنجاح.