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