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

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

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

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

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

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

لمزيد من المعلومات، راجِع مقدمة حول النشر.

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

المصطلح	التعريف
منتج واجهة برمجة التطبيقات	هو مجموعة من الخوادم الوكيلة لواجهة برمجة التطبيقات مع خطة خدمة تضع حدودًا للوصول إلى واجهات برمجة التطبيقات هذه. منتجات واجهة برمجة التطبيقات هي الآلية المركزية التي تستخدمها Apigee Edge للتفويض والتحكّم في الوصول إلى واجهات برمجة التطبيقات الخاصة بك.
مطوّر البرامج	مستهلك واجهة برمجة التطبيقات. يكتب المطوّرون التطبيقات التي ترسل طلبات إلى واجهات برمجة التطبيقات.
التطبيق	هو تطبيق من جهة العميل يسجّله المطوّر للوصول إلى منتج واجهة برمجة التطبيقات. يؤدي تسجيل التطبيق في منتج واجهة برمجة التطبيقات إلى إنشاء مفتاح واجهة برمجة التطبيقات للوصول إلى واجهات برمجة التطبيقات في هذا المنتج.
مفتاح واجهة برمجة التطبيقات	سلسلة تتضمّن معلومات التفويض التي يستخدمها تطبيق من جهة العميل للوصول إلى الموارد التي يعرضها منتج واجهة برمجة التطبيقات يتم إنشاء مفتاح واجهة برمجة التطبيقات عندما يكون تطبيق مسجَّل مرتبطًا بمنتج واجهة برمجة تطبيقات.

المتطلبات الأساسية لهذا الدليل التوجيهي

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

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

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

   الحقل	القيمة
   الاسم	منتج مجاني لواجهة برمجة التطبيقات
   الاسم المعروض	منتج مجاني لواجهة برمجة التطبيقات
   الوصف	منتج مجاني لواجهة برمجة التطبيقات
   البيئة	اختبار
   إمكانية الوصول	للاستخدام الداخلي فقط
   نوع الموافقة على المفتاح	تلقائي (تتم الموافقة على مفتاح واجهة برمجة التطبيقات تلقائيًا بعد إنشائه)
   الحصة	10 طلبات في الساعة (بحد أقصى عدد الطلبات إلى 10 طلبات في الساعة)
   نطاقات OAuth المسموح بها	اتركه فارغًا

   يُفترض أن يظهر مربع الحوار المعبأ على النحو التالي:

   

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

استبدِل اسم مؤسسة Apigee بـ {org-name} وقيمة 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: ما الخطوة التالية؟

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

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