البرنامج التعليمي: إنشاء منتج ونشره

ينطبق على: جميع مستويات إدارة واجهة برمجة التطبيقات

في Azure API Management، يحتوي المنتج على واحد أو أكثر من واجهات برمجة التطبيقات، وحصة الاستخدام، وشروط الاستخدام. بعد نشر المنتج، يمكن للمطورين الاشتراك في المنتج والبدء في استخدام واجهات برمجة التطبيقات الخاصة بالمنتج.

في هذا البرنامج التعليمي، تتعلم كيفية:

• إنشاء منتج ونشره
• إضافة واجهة برمجة تطبيقات إلى المنتج
• عملية الوصول إلى واجهات برمجة تطبيقات المنتج

المتطلبات الأساسية

• التعرف على Azure API Management terminology.
• أكمل التشغيل السريع التالي:إنشاء مثيل لـ Azure API Management.
• كما يلزم إتمام البرنامج التعليمي التالي: استيراد ونشر واجهة برمجة التطبيقات الأولى الخاصة بك.

إنشاء منتج ونشره

المدخل

1. سجل الدخول إلى مدخل Azure، وانتقل إلى مثيل إدارة واجهة برمجة التطبيقات الخاصة بك.

2. في جزء التنقل الأيسر، حدد المنتجات>+ إضافة.

   

3. في إطار إضافة منتج، أدخل القيم الموضحة في الجدول التالي لإنشاء المنتج الخاص بك.

   

   Name	‏‏الوصف
   ‏‫اسم العرض‬	الاسم كما تريد أن يظهر في مدخل المطور.
   ‏‏الوصف	قدم معلومات حول المنتج مثل الغرض منه وواجهات برمجة التطبيقات التي يوفر الوصول إليها وتفاصيل أخرى.
   الولاية	حدد منشور إذا كنت تريد نشر المنتج. يجب نشر المنتج قبل إمكانية استدعاء واجهات برمجة التطبيقات له. بشكل افتراضي، لا يتم نشر المنتجات الجديدة، وتكون مرئية فقط لمجموعة المسؤولين.
   يتطلب الاشتراك	حدد ما إذا كان المستخدم مطالبًا بالاشتراك في استخدام المنتج (المنتج محمي)، ويتعين استخدام مفتاح اشتراك للوصول إلى API للمنتج. في حالة لم يكن الاشتراك مطلوبًا (المنتج مفتوح)، فلن يكون مفتاح الاشتراك مطلوبًا للوصول إلى API للمنتج. راجع الوصول إلى API للمنتج لاحقًا في هذه المقالة.
   يتطلب الموافقة	حدد ما إذا كنت تريد أن يقوم المسؤول بمراجعة وقبول أو رفض محاولات الاشتراك في هذا المنتج. في حالة عدم التحديد، تتم الموافقة على محاولات الاشتراك تلقائيًا.
   حد عدد الاشتراكات	حدد عدد الاشتراكات المتزامنة المتعددة بشكل اختياري.
   ‏‏الشروط القانونية	يمكنك تضمين شروط استخدام المنتج التي يجب على المشتركين قبولها من أجل استخدام المنتج.
   واجهات برمجة التطبيقات (API)	تحديد واجهة برمجة تطبيقات أو أكثر. يمكنك أيضًا إضافة واجهات برمجة التطبيقات بعد إنشاء المنتج. لمزيد من المعلومات، راجع إضافة واجهات برمجة التطبيقات إلى منتج في وقت لاحق من هذه المقالة. في حالة كان المنتج مفتوحًا (لا يتطلب اشتراكًا)، يمكنك فقط إضافة API غير مقترنة بمنتج مفتوح آخر.

4. حدد إنشاء لإنشاء منتجك الجديد.

تنبيه

استخدم الرعاية عند تكوين منتج لا تتطلب اشتراكًا. قد يكون هذا التكوين متساهلًا بشكل مفرط وقد يجعل API الخاصة بالمنتج أكثر عرضة لـ تهديدات أمان معينة لـ API.

Azure CLI

للبدء في استخدام Azure CLI:

• استخدم بيئة Bash في Azure Cloud Shell. لمزيد من المعلومات، راجع التشغيل السريع ل Bash في Azure Cloud Shell.

  

• إذا كنت تفضل تشغيل أوامر مرجع CLI محلياً قم بتثبيت CLI Azure. إذا كنت تعمل على نظام تشغيل Windows أو macOS، ففكر في تشغيل Azure CLI في حاوية Docker. لمزيد من المعلومات، راجع كيفية تشغيل Azure CLI في حاوية Docker.

  • إذا كنت تستخدم تثبيت محلي، يُرجى تسجيل الدخول إلى Azure CLI مستخدمًا أمر az login. لإنهاء عملية المصادقة، اتبع الخطوات المعروضة في جهازك. للحصول على خيارات أخرى لتسجيل دخول، راجع تسجيل الدخول باستخدام Azure CLI.

  • عندما يُطلب منك، قم بتثبيت ملحق Azure CLI عند الاستخدام لأول مرة. لمزيد من المعلومات بشأن الامتدادات، راجع استخدام امتدادات مع Azure CLI.

  • يُرجى تشغيل إصدار az للوصول إلى الإصدار والمكتبات التابعة التي تم تثبيتها. للتحديث لآخر إصدار، يُرجى تشغيل تحديث az.

لإنشاء منتج، قم بتشغيل الأمر إنشاء منتج az apim:

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

يمكنك تحديد قيم مختلفة لمنتجك:

المعلمة	‏‏الوصف‬
--product-name	الاسم كما تريد أن يظهر في مدخل المطور.
--description	قدم معلومات حول المنتج مثل الغرض منه وواجهات برمجة التطبيقات التي يوفر الوصول إليها وتفاصيل أخرى.
--state	حدد منشور إذا كنت تريد نشر المنتج. يجب نشر المنتج قبل إمكانية استدعاء واجهات برمجة التطبيقات له. بشكل افتراضي، لا يتم نشر المنتجات الجديدة، وتكون مرئية فقط لمجموعة المسؤولين.
--subscription-required	حدد ما إذا كان المستخدم مطالبًا بالاشتراك في استخدام المنتج (المنتج المحمي) أو في حالة لم يكن الاشتراك مطلوبًا (المنتج مفتوح). راجع الوصول إلى API للمنتج لاحقًا في هذه المقالة.
--approval-required	حدد ما إذا كنت تريد أن يقوم المسؤول بمراجعة وقبول أو رفض محاولات الاشتراك في هذا المنتج. في حالة عدم التحديد، تتم الموافقة على محاولات الاشتراك تلقائيًا.
--subscriptions-limit	بشكل اختياري، حدد عدد الاشتراكات المتزامنة المتعددة.
--legal-terms	يمكنك تضمين شروط استخدام المنتج التي يتعين على المشتركين قبولها من أجل استخدام المنتج.

تنبيه

استخدم الرعاية عند تكوين منتج لا تتطلب اشتراكًا. قد يكون هذا التكوين متساهلًا بشكل مفرط وقد يجعل API الخاصة بالمنتج أكثر عرضة لـ تهديدات أمان معينة لـ API.

للاطلاع على منتجاتك الحالية، استخدم الأمر قائمة منتجات az apim:

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

يمكنك حذف منتج باستخدام الأمر az apim product delete.

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

إضافة المزيد من التكوينات

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

عنصر	‏‏الوصف
إعدادات	بيانات تعريف المنتج وحالته
واجهات برمجة التطبيقات (API)	واجهات برمجة التطبيقات المرتبطة بالمنتج
السياسات	السياسات المطبقة على واجهات برمجة التطبيقات للمنتجات
عنصر تحكم الوصول	رؤية المنتج للمطورين أو الضيوف
الاشتراكات	المشتركون في المنتجات

إضافة واجهات برمجة التطبيقات إلى منتج

المنتجات عبارة عن اتحادات لواحدة أو أكثر من واجهات برمجة التطبيقات. يمكنك تضمين العديد من واجهات برمجة التطبيقات وتقديمها للمطورين من خلال بوابة المطور. أثناء إنشاء المنتج، يمكنك إضافة واحدة أو أكثر من واجهات برمجة التطبيقات الحالية. يمكنك أيضًا إضافة واجهات برمجة التطبيقات إلى المنتج لاحقًا، إما من صفحةإعدادات المنتجات أو في أثناء إنشاء واجهة برمجة التطبيقات.

إضافة واجهة برمجة تطبيقات إلى منتج موجود

المدخل

1. في التنقل الأيمن لمثيل إدارة واجهة برمجة التطبيقات، حددالمنتجات.
2. حدد منتجًا، ثم حدد API.
3. حدد + Add API.
4. حدد واحدة أو أكثر من API ثم حدد.

Azure CLI

1. تشغيل الأمر az apim api list لمشاهدة معرفات واجهات برمجة التطبيقات الخاصة بك:

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. لإضافة واجهة برمجة التطبيقات إلى المنتج الخاص بك، قم بتشغيل الأمر إضافة az apim المنتج إضافة:

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. تحقق من الإضافة باستخدام الأمر az apim product api list:

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

يمكنك إزالة واجهة برمجة تطبيقات في أحد المنتجات باستخدام الأمر az apim product api delete.

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

الوصول إلى واجهات برمجة تطبيقات الخاصة بالمنتج

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

• المنتج المحمي - يتعين على المطورين أولًا الاشتراك في منتج محمٍ للوصول إلى واجهات برمجة التطبيقات الخاصة بالمنتج. عندما يشتركون، يحصلون على مفتاح اشتراك مميز لأي واجهة برمجة تطبيقات في هذا المنتج. إذا قمت بإنشاء مثيل APIM، فأنت مسؤول بالفعل، لذلك يتم الاشتراك في كل منتج بشكل افتراضي. للحصول على مزيدٍ من المعلومات فيما يتعلق بالاشتراكات، راجع الاشتراكات في إدارة Azure API.

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

  تلميح

  يمكنك إنشاء أو تحديث اشتراك مستخدم لمنتج باستخدام مفاتيح الاشتراك المخصصة من خلال أمر REST API أو PowerShell.

• فتح المنتج - يمكن للمطورين الوصول إلى واجهات برمجة التطبيقات الخاصة بمنتج مفتوح دون مفتاح الاشتراك. ومع ذلك، يمكنك تكوين آليات أخرى لتأمين عملية وصول العميل إلى واجهات برمجة التطبيقات، بما في ذلك OAuth 2.0، وشهادات العميل، وتقييد عناوين IP للمتصل.

  إشعار

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

  عندما يقوم عميل بإجراء طلب واجهة برمجة تطبيقات دون مفتاح اشتراك:

  • تتحقق APIM مما إذا كانت واجهة برمجة التطبيقات مقترنة بالمنتج المفتوح. يمكن ربط واجهة برمجة التطبيقات بمنتج مفتوح واحد على الأكثر.

  • في حالة كان المنتج المفتوح موجودًا، فإنه يعالج الطلب في سياق هذا المنتج المفتوح. يمكن تطبيق النهج وقواعد التحكم في الوصول التي تم تكوينها لمنتج مفتوح.

لمزيد من المعلومات، راجع كيفية معالجة إدارة واجهة برمجة التطبيقات للطلبات باستعمال مفاتيح الاشتراك أو دونها.

الخطوات التالية

في هذا البرنامج التعليمي، نتعلم طريقة القيام بما يأتي:

• إنشاء منتج ونشره
• إضافة واجهة برمجة تطبيقات إلى المنتج
• عملية الوصول إلى واجهات برمجة تطبيقات المنتج

تقدم إلى البرنامج التعليمي الآتي:

إنشاء واجهة برمجة تطبيقات فارغة ونماذج من استجابات واجهة برمجة التطبيقات