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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• استخدِم واجهة برمجة التطبيقات Apigee Edge management API لدمج وظيفة التسجيل في موقعك الإلكتروني الحالي. ‫Edge management API هي واجهة برمجة تطبيقات REST API يمكنك استخدامها لتنفيذ جميع جوانب عملية تسجيل المطوّرين. اطّلِع على استخدام واجهة برمجة التطبيقات Edge management API لنشر واجهات برمجة التطبيقات للاطّلاع على مزيد من المعلومات.
• استخدِم منصة 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 هي واجهة برمجة تطبيقات REST تتيح لك الوصول إلى خدمات واجهة برمجة التطبيقات باستخدام أي برمجي برمجة تطبيقات HTTP. تستخدِم Apigee أداة SmartDocs لإنشاء مستندات تفاعلية لواجهة برمجة التطبيقات Edge management API. يمكنك الاطّلاع على مستندات واجهة برمجة التطبيقات هنا.

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