نظرة عامة على النشر

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

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

يتضمّن نشر واجهات برمجة التطبيقات المهام التالية الموضّحة في هذا الموضوع:

1. أنشئ منتجات واجهة برمجة التطبيقات على Edge التي تضمّ واجهات برمجة التطبيقات.
2. تسجيل مطوّري التطبيقات على Edge
3. تسجيل تطبيقات المطوّرين على Edge
4. توفير مستندات ودعم من المنتدى لواجهات برمجة التطبيقات

المهمة 1: إنشاء منتج API على Edge

تتمثل المهمة الأولى في عملية النشر في إنشاء منتج API. منتج واجهة برمجة التطبيقات هو مجموعة من موارد واجهة برمجة التطبيقات التي يتم تقديمها كحزمة لمطوّري التطبيقات لاستخدامها. يمكنك إنشاء منتجات واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات الإدارية في Edge أو واجهة المستخدم. (يمكنك الاطّلاع على المقالة ما هو منتج API؟ لمعرفة المزيد من المعلومات عن منتجات API.)

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

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

• إصدار منتج مجاني من واجهة برمجة التطبيقات يسمح بالوصول للقراءة فقط إلى موارد واجهة برمجة التطبيقات
• أطلِق منتجًا ثانيًا من واجهة برمجة التطبيقات بسعر منخفض يتيح إذن القراءة والكتابة لموارد واجهة برمجة التطبيقات نفسها التي يتيحها الإصدار المجاني، ولكن مع حدّ منخفض للوصول، مثل 1, 000 طلب في اليوم.
• طرح منتج ثالث من واجهة برمجة التطبيقات بسعر أعلى يتيح الوصول للقراءة والكتابة إلى مصدر واجهة برمجة التطبيقات نفسه ولكن مع حدّ أعلى للوصول

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

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

المهمة 2: تسجيل مطوّر تطبيقات على Edge

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

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

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

توفّر Apigee أيضًا أدوات يمكنك استخدامها لأتمتة عملية تسجيل المطوّرين. على سبيل المثال:

• استخدِم واجهة برمجة التطبيقات الإدارية Apigee Edge لدمج وظيفة التسجيل في موقعك الإلكتروني الحالي. ‫Edge management API هي واجهة REST API يمكنك استخدامها لتنفيذ جميع جوانب عملية تسجيل المطوّرين. لمزيد من المعلومات، اطّلِع على استخدام واجهة برمجة التطبيقات الخاصة بإدارة Edge لنشر واجهات برمجة التطبيقات.
• استخدِم بوابة Apigee Developer Services لتسجيل المطوّرين. تتضمّن البوابة دعمًا مدمجًا لتسجيل المطوّرين، كما تتضمّن العديد من الميزات الأخرى لدعم واجهات برمجة التطبيقات. يمكنك الاطّلاع على ما هي بوابة المطوّرين؟ لمعرفة المزيد.

المهمة 3: تسجيل تطبيق مطوّر على Edge

قبل أن يتمكّن تطبيق من الوصول إلى واجهات برمجة التطبيقات، يجب تسجيله على Edge. ومع ذلك، يمكن للمطوّر المسجَّل فقط تسجيل تطبيق على Edge.

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

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

بصفتك مقدّم واجهة برمجة تطبيقات، يمكنك تحديد الطريقة التي تريد استخدامها لتسجيل التطبيقات. وفي هذا الإطار، يمكنك تنفيذ الإجراءات التالية:

• استخدام عملية يدوية تتطلّب من المطوّر التواصل مع مؤسستك لتسجيل التطبيق، ثم إرسال مفتاح واجهة برمجة التطبيقات إلى المطوّر، ربما عبر البريد الإلكتروني
• استخدِم واجهة برمجة التطبيقات Edge Management API لدمج وظيفة تسجيل التطبيق وتسليم المفتاح في موقعك الإلكتروني.
• بالنسبة إلى حساب Edge مدفوع، استخدِم بوابة Apigee Developer Services التي تتضمّن دعمًا مدمجًا لتسجيل التطبيقات وتسليم مفتاح واجهة برمجة التطبيقات.

لمزيد من المعلومات، يُرجى الاطّلاع على تسجيل التطبيقات وإدارة مفاتيح واجهة برمجة التطبيقات.

المهمة 4: توثيق واجهات برمجة التطبيقات

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

يمكنك إنشاء موقعك الإلكتروني الخاص لنشر مستنداتك، أو يمكنك استخدام بوابة Apigee Developer Services إذا كان لديك حساب Edge مدفوع. يتضمّن البوابة دعمًا مدمجًا للمستندات والمدوّنات والمنتديات وأنواع المحتوى الأخرى المطلوبة لدعم منتدى المطوّرين.

تتيح لك SmartDocs توثيق واجهات برمجة التطبيقات على بوابة "خدمات المطوّرين" بطريقة تجعل مستندات واجهة برمجة التطبيقات تفاعلية بالكامل. تتيح المستندات التفاعلية باستخدام SmartDocs لمستخدمي البوابة ما يلي:

• مزيد من المعلومات حول واجهة برمجة التطبيقات
• إرسال طلب مباشر إلى واجهة برمجة التطبيقات
• عرض ردّ مباشر تم إرجاعه من واجهة برمجة التطبيقات

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

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

واجهة Edge Management API هي واجهة REST API تتيح لك الوصول إلى "خدمات واجهة برمجة التطبيقات" باستخدام أي عميل HTTP. تستخدم Apigee أداة SmartDocs لإنشاء مستندات تفاعلية لواجهة برمجة التطبيقات الخاصة بإدارة Edge. يمكنك الاطّلاع على مستندات واجهة برمجة التطبيقات هنا.

لمزيد من المعلومات، يُرجى الاطّلاع على استخدام SmartDocs لإنشاء مستندات خاصة بواجهات برمجة التطبيقات.