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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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