تمرين - اتصال بواجهة برمجة التطبيقات (API) عن طريق استخدام مفتاح اشتراك

مكتمل

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

في مثال شركة الأحذية، تعمل شركة ”NorthWind Shoes“ مع مورد وتريد الوصول مباشرة إلى API للمخزون. يجب تقييد وصول الشريك باستخدام مفتاح اشتراك لجميع المكالمات إلى واجهة برمجة التطبيقات.

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

الحصول على مفتاح اشتراك

يتم إعطاء الشركاء المفتاح الخاص بهم كجزء من عملية الانتساب. في هذا التمرين، يمكنك إضافة اشتراك خصيصا ل NorthWindShoes API. بمجرد حصولك على مفتاح، يمكنك اتباع عملية قياسية لاستخدام المفتاح في استدعاءات واجهة برمجة التطبيقات.

  1. في قائمة مدخل Microsoft Azure أو من صفحة Home ، حدد All resources، ثم حدد مثيل API Management.

  2. في جزء القائمة الأيسر، ضمن APIs حدد Subscriptions.

  3. حدد + Subscription، وأدخل القيم التالية لكل إعداد. ثم حدد إنشاء.

    الإعداد القيمة
    الاسم NorthWind
    ‏‫اسم العرض‬ NorthWind subscription
    Scope حدد API، ثم حدد NorthWindShoes Products من القائمة المنسدلة.
  4. حدد قائمة السياق (...) لاشتراك Northwind، ثم حدد إظهار/إخفاء المفاتيح.

  5. قم بالنقر فوق Click to copy زر المفتاح PRIMARY KEY.

  6. قم بحفظ هذا المفتاح في مكان ما، مثل مفكرة.

قم باستخدام مفتاح اشتراك في استدعاء API

الخطوة التالية هي استخدام مفتاح الاشتراك لكي يتم اختبار وصول المطورين إلى API التي تم نشرة.

  1. تشغيل الأمر التالي في Cloud Shell للوصول إلى عملية Products في API الخاص بك، واستبدالها <apim gateway> مع اسم البوابة الخاصة بك.

    curl https://<apim gateway>.azure-api.net/api/Products
    

    تحصل على 401، تم رفض الوصول بسبب فقدان رسالة مفتاح الاشتراك.

  2. كرر الآن طلب curl الخاص بك، هذه المرة بما في ذلك مفتاح الاشتراك الخاص بك.

  3. تشغيل الأمر التالي في Cloud Shell واستبدال <primary key> المفتاح الذي حفظته سابقاً، واستبدالها <apim gateway> باسم البوابة.

    curl --header "Ocp-Apim-Subscription-Key: <primary key>" https://<apim gateway>.azure-api.net/api/Products
    

    بنبغي عليك الآن التمكن من الوصول إلى API، ومشاهدة قائمة المنتجات التي تم إرجاعها إلى وحدة التحكم.