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