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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

واجهة برمجة تطبيقات إدارة Edge هي واجهة برمجة تطبيقات REST تتيح لك الوصول إلى خدمات واجهة برمجة التطبيقات باستخدام أي عميل HTTP. تستخدم Apigee Smart Docs لإنشاء وثائق تفاعلية لواجهة برمجة تطبيقات إدارة Edge. يمكنك الاطّلاع على وثائق واجهة برمجة التطبيقات هذه هنا.

لمزيد من المعلومات، راجِع استخدام Smart Docs لتوثيق واجهات برمجة التطبيقات.