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

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

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

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

لتسهيل هذه العملية، عليك إجراء بعض الإعدادات. لتفعيل مفاتيح واجهة برمجة التطبيقات، عليك إجراء ما يلي:

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

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

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

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

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

في Apigee Edge، يُشار إلى مفتاح واجهة برمجة التطبيقات باسم مفتاح المستهلك. عند تسجيل تطبيقات المطوّرين، تنشئ Apigee Edge مفتاح مستهلك وكلمة سر. تخزِّن Apigee Edge مفتاح المستهلك للتحقّق منه في المستقبل. يكون كل مفتاح مستهلك فريدًا في المؤسسة. يُدمِج مطوّر التطبيق مفتاح المستهلك في تطبيق العميل. ويجب أن يقدّم تطبيق العميل مفتاح المستهلك لكل طلب. تتحقّق "خدمات واجهة برمجة التطبيقات" من مفتاح المستهلك قبل السماح بطلب التطبيق.

الخطوات العامة

توضِّح الخطوات التالية كيفية استخدام مفاتيح واجهة برمجة التطبيقات من قِبل Apigee Edge. وتشمل هذه الخطوات احتمال توفُّر أمان OAuth أيضًا، لأنّه غالبًا ما يتم استخدامه مع مفاتيح واجهة برمجة التطبيقات.

1. أنشئ منتجًا لواجهة برمجة التطبيقات يتضمّن أدوات وكيل لواجهة برمجة التطبيقات يجب حمايتها باستخدام مفتاح واجهة برمجة التطبيقات.
2. تسجيل تطبيق مطوّر في مؤسستك عند إجراء ذلك، تنشئ Apigee Edge مفتاح مستخدم وكلمة سر مستخدم.
3. ربط تطبيق المطوّر بمنتج واحد على الأقل من منتجات واجهة برمجة التطبيقات وهو المنتج الذي يربط مسارات الموارد ووكلاء واجهة برمجة التطبيقات بموافقة المفتاح.
4. في وقت التشغيل، عندما يُرسل تطبيق العميل طلبًا إلى واجهة برمجة التطبيقات، يُرسِل تطبيق العميل مفتاح المستخدِم عند إرسال الطلب. من الناحية العملية، قد يتم تمرير مفتاح العميل بشكل صريح أو قد تتم الإشارة إليه بشكل ضمني من خلال رمز مميّز لبروتوكول OAuth:
   • عندما تستخدم واجهة برمجة التطبيقات عملية إثبات ملكية مفتاح واجهة برمجة التطبيقات، مثل تنفيذ سياسة VerifyAPIKey ، يجب أن يُرسل تطبيق العميل مفتاح المستهلك صراحةً.
   • عندما تستخدم واجهة برمجة التطبيقات عملية إثبات ملكية رمز OAuth، مثلاً من خلال تنفيذ سياسة OAuthV2 ، على تطبيق العميل إرسال رمز مميّز تم استخراجه من مفتاح العميل.
5. يُجري وسيط واجهة برمجة التطبيقات عملية التحقّق من بيانات اعتماد الطلب من خلال سياسة VerifyAPIKey أو سياسة OAuthV2 مع عملية VerifyAccessToken. إذا لم يتم تضمين سياسة فرض بيانات الاعتماد في وكيل واجهة برمجة التطبيقات، يمكن لأي مُرسِل طلبٍ تنفيذ طلبات بيانات من واجهات برمجة التطبيقات بنجاح. لمزيد من المعلومات، يُرجى الاطّلاع على سياسة التحقّق من مفتاح واجهة برمجة التطبيقات.

التحقّق من بيانات اعتماد الطلب

هذه نظرة عامة. يُرجى الاطّلاع على إعداد عملية التحقّق من مفتاح واجهة برمجة التطبيقات للحصول على التفاصيل وأمثلة الرموز.

1. إذا كنت تستخدِم عملية التحقّق من رمز OAuth، يعني ذلك أنّك نفّذت سياسة OAuth للتحقّق من صحتها، وأنّ تطبيق العميل قد أرسل رمز OAuth:
   • تتحقّق Apigee Edge من أنّ الرمز المميّز لم ينتهِ صلاحيته، ثم تبحث عن مفتاح المستهلك الذي تم استخدامه لإنشاء الرمز المميّز.
2. إذا كنت تستخدم مفتاح واجهة برمجة التطبيقات، يعني ذلك أنّك نفّذت سياسة VerifyAPIKey وأنّ تطبيق العميل قد اجتاز مفتاح المستهلك:
   1. تتحقّق Apigee Edge من قائمة منتجات واجهة برمجة التطبيقات التي تم ربط مفتاح المستهلك بها.
   2. تتحقّق Edge من كل منتج لواجهة برمجة التطبيقات لمعرفة ما إذا كان وكيل واجهة برمجة التطبيقات الحالي مضمّنًا في منتج واجهة برمجة التطبيقات، وما إذا كان مسار المورد الحالي (مسار عنوان URL) مفعّلاً في منتج واجهة برمجة التطبيقات.
   3. يتحقّق Edge أيضًا من أنّ مفتاح المستهلك لم ينته صلاحيته أو تم إبطاله، ويتحقّق من أنّه لم يتم إبطال التطبيق ، ويتحقّق من أنّ المطوّر ليس غير نشط.
   4. إذا كانت كل هذه الشروط صحيحة، أي أنّ الرمز المميّز لم تنته صلاحيته (إن وُجد)، ومفتاح المستهلك صالح وتمت الموافقة عليه، والتطبيق موافَق عليه، والمطوّر نشط، ووكيل البريد متاح في المنتج، والمورد متاح في المنتج، سيتم إكمال عملية التحقّق من بيانات الاعتماد.