الجزء 2: إنشاء مفتاح واجهة برمجة التطبيقات واختباره

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

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

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

النشر هو عملية إتاحة واجهات برمجة التطبيقات لمطوّري التطبيقات لاستخدامها. يمكن تحديد عملية نشر واجهات برمجة التطبيقات بشكل عام من خلال المهام التالية:

1. إنشاء منتجات واجهة برمجة التطبيقات على Apigee Edge التي تجمع واجهات برمجة التطبيقات.
2. تسجيل مطوّري التطبيقات على Edge لا يمكن لأي مطوّر تطبيقات مسجَّل تسجيل تطبيق.
3. يسجّل المطوّرون التطبيقات على Edge للوصول إلى منتجات واجهة برمجة التطبيقات. في المقابل، يتلقّى المطوّر مفتاح واجهة برمجة التطبيقات. بعد حصول المطوّر على مفتاح واجهة برمجة التطبيقات، يمكنه إرسال طلبات إلى واجهات برمجة التطبيقات.

لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مقدّمة عن النشر.

يحدّد الجدول التالي بعض المصطلحات المستخدَمة لتسجيل التطبيقات وإنشاء المفاتيح:

المتطلبات الأساسية لهذا البرنامج التعليمي

يفترض هذا البرنامج التعليمي أنّك أكملت البرنامج التعليمي الأول الذي أنشأت فيه خادم وكيل لواجهة برمجة التطبيقات للوصول إلى Yahoo weather API. إذا لم تكن قد أكملت البرنامج التعليمي الأول بعد، يُرجى الاطّلاع على مقالة تأمين واجهة برمجة التطبيقات من خلال طلب مفاتيح واجهة برمجة التطبيقات.

الخطوة 1: إنشاء منتج واجهة برمجة التطبيقات

1. في واجهة إدارة المستخدم، انقر على علامة التبويب نشر ، ثم المنتجات.
2. انقر على (+) المنتج.
3. أدخِل ما يلي أو اختَره في حقول مربّع الحوار "إضافة منتج":

   الحقل	القيمة
   الاسم	Free API Product
   الاسم المعروض	Free API Product
   الوصف	Free API Product
   البيئة	اختبار
   إذن الوصول	داخلي فقط
   نوع الموافقة على المفتاح	تلقائي (تتم الموافقة تلقائيًا على مفتاح واجهة برمجة التطبيقات بعد إنشائه)
   Quota	10 طلبات في الساعة (يحدّ عدد الطلبات بـ 10 في الساعة)
   نطاقات OAuth المسموح بها	يجب ترك هذا الحقل فارغًا.

   يجب أن يبدو مربّع الحوار بعد ملئه على النحو التالي:

   

4. في قسم "الموارد"، اختَر:
   • خادم وكيل لواجهة برمجة التطبيقات: weatherapikey
   • الإصدار: 1
   • مسار المورد: /forecastrss**
     
     يحدّد مسار المورد معرّفات الموارد المنتظمة (URI) التي يسمح المنتج للتطبيق بالوصول إليها. في هذا المثال، لا يمكن للتطبيق الوصول إلا إلى المورد /forecastrss على خادم وكيل weatherapikey من خلال منتج واجهة برمجة التطبيقات هذا. يُحظر محاولة استخدام منتج واجهة برمجة التطبيقات هذا للوصول إلى أي مورد آخر على خادم وكيل weatherapiproxy أو على أي خادم وكيل آخر.
     
     يُسمح بأحرف البدل في مسار المورد. يشير حرف البدل "/**" إلى تضمين جميع معرّفات الموارد المنتظمة الفرعية، ما يعني موردًا بالصيغة /forecastrss/foo/bar. يشير حرف البدل "/" إلى تضمين معرّفات الموارد المنتظمة التي تكون على مستوى واحد فقط. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إنشاء منتجات واجهة برمجة التطبيقات.
     
     يُرجى العِلم أنّ القائمة المنسدلة مسار المورد تعرض جميع التدفقات الشرطية المحدّدة على خادم وكيل واجهة برمجة التطبيقات المحدّد. يحدّد التدفق الشرطي لخادم وكيل واجهة برمجة التطبيقات المنطق أو خطوات المعالجة المرتبطة بمسار المورد. يتحكّم منتج واجهة برمجة التطبيقات في الوصول إلى مسارات الموارد هذه.
     
5. انقر على استيراد المورد. تتم إضافة مسار المورد، ويتم تلقائيًا إضافة خادم وكيل واجهة برمجة التطبيقات weatherapikey إلى قسم خوادم وكيل واجهة برمجة التطبيقات للمنتج.
6. انقر على حفظ. يظهر منتجك الجديد في صفحة "المنتجات".

مزيد من المعلومات:

• إنشاء منتجات واجهة برمجة التطبيقات

الخطوة 2: تسجيل مطوّر برامج

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

1. في واجهة إدارة المستخدم، انقر على علامة التبويب نشر ، ثم المطوّرون.
2. انقر على (+) مطوّر برامج.
3. في مربّع الحوار "مطوّر برامج جديد"، أدخِل القيم التالية:
   • الاسم الأول: Jane
   • اسم العائلة: Tutorial
   • عنوان البريد الإلكتروني: janetutorial@example.com
   • اسم المستخدم: jtutorial
4. انقر على حفظ. يظهر المطوّر الجديد في قائمة المطوّرين في صفحة "المطوّرون".

مزيد من المعلومات:

• إدارة مطوّري التطبيقات

الخطوة 3: تسجيل التطبيق

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

1. في واجهة "منصة واجهة برمجة التطبيقات"، انقر على علامة التبويب نشر ، ثم على تطبيقات المطوّرين.
2. انقر على (+) تطبيق المطوّر.
3. في مربّع الحوار "إضافة تطبيق"، أدخِل القيم التالية:
   • الاسم المعروض: Weather API Key App
   • المطوّر: Jane Tutorial (janetutorial@example.com)
   • عنوان URL لرد الاتصال: يجب ترك هذا الحقل فارغًا.
4. اربط التطبيق بمنتج:
   1. في قسم المنتجات ، انقر على + المنتج.
   2. اختَر Free API Product.
   3. انقر على رمز علامة الاختيار لقبول التغييرات.
5. انقر على حفظ. يظهر التطبيق الجديد في قائمة التطبيقات في صفحة "تطبيقات المطوّرين" .
6. اختَر Weather API Key App من قائمة التطبيقات. يؤدي ذلك إلى فتح صفحة تفاصيل التطبيق.
7. بما أنّك اخترت نوع الموافقة على المفتاح: تلقائي عند إنشاء منتج واجهة برمجة التطبيقات ، تتم الموافقة تلقائيًا على مفتاح واجهة برمجة التطبيقات ويمكنك الاطّلاع عليه على الفور. (إذا كنت قد اخترت نوع الموافقة: يدوي، عليك النقر على الموافقة في عمود "الإجراءات" لمنتج واجهة برمجة التطبيقات المجاني للموافقة على مفتاح واجهة برمجة التطبيقات.)
8. في قسم "المنتجات"، انقر على عرض في عمودَي مفتاح المستهلك وسرّ المستهلك بجانب إدخال "منتج واجهة برمجة التطبيقات المجاني" لعرض المفاتيح التي تم إنشاؤها.
   

   مفتاح المستهلك هو اسم آخر لمفتاح واجهة برمجة التطبيقات وهو المفتاح الوحيد الذي يحتاج إليه التطبيق للوصول إلى مورد التوقعات من خلال خادم وكيل واجهة برمجة التطبيقات . مطلوب سرّ المستهلك (بالإضافة إلى مفتاح المستهلك) في تأمين واجهة برمجة التطبيقات من خلال OAuth 2.0. على سبيل المثال، يُرجى الاطّلاع على مقالة OAuth 2.0: إعداد خادم وكيل جديد لواجهة برمجة التطبيقات.

مزيد من المعلومات:

• تسجيل التطبيقات و إدارة مفاتيح واجهة برمجة التطبيقات.

الخطوة 4: استخدام مفتاح واجهة برمجة التطبيقات في طلب

لضمان عمل سياسة VerifyAPIKey بشكل صحيح، عليك اختبارها من خلال إجراء طلب إلى خادم وكيل واجهة برمجة التطبيقات باستخدام مفتاح واجهة برمجة تطبيقات صالح. يمكنك طلب خادم وكيل واجهة برمجة التطبيقات في متصفّح أو من صفحة "التتبُّع" لخادم وكيل واجهة برمجة التطبيقات أو من Apigee Console أو باستخدام cURL. يكون عنوان URL المطلوب على الشكل التالي:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

استبدِل {org-name} باسم مؤسسة Apigee وقيمة apikey الصحيحة.

ابحث عن المحتوى التالي في الردّ:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

إذا لم تضمّن مفتاح واجهة برمجة التطبيقات في الطلب أو حدّدت قيمة مفتاح غير صالحة، ستتلقّى ردًا يتضمّن خطأً على الشكل التالي:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

الخطوة 5: ما هي الخطوة التالية؟

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