درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
انتشار فرایند دردسترس قرار دادن میاناهای برنامه‌سازی کاربردی برای توسعه‌دهندگان نرم‌افزار برای مصرف است.
ویدیو: ویدیو زیر مقدمه‌ای سطح بالا بر انتشار API ارائه می‌دهد.
انتشار «میاناهای برنامه‌سازی کاربردی» شامل وظایف زیر است که در این موضوع شرح داده شده است:
- محصولات API را در Edge ایجاد کنید که APIهای شما را دسته‌بندی می‌کند.
- توسعه‌دهندگان نرم‌افزار را در Edge ثبت کنید.
- برنامه‌های توسعه‌دهنده را در Edge ثبت کنید.
- برای میاناهای برنامه‌سازی کاربردی خود مستندسازی و پشتیبانی انجمن ارائه دهید.
تکلیف ۱: ایجاد محصول API در Edge
اولین کار در انتشار، ایجاد محصول API است. محصول API مجموعه‌ای از منابع API است که به‌عنوان بسته‌ای برای مصرف توسعه‌دهندگان نرم‌افزار ارائه می‌شود. محصولات میانای برنامه‌سازی کاربردی را بااستفاده از میانای برنامه‌سازی کاربردی یا واسط کاربر مدیریت Edge ایجاد کنید. (برای کسب اطلاعات بیشتر درباره محصولات API، محصول API چیست؟ را ببینید.)
در این شکل، «میانای برنامه‌سازی کاربردی» از دو محصول تشکیل شده است که هرکدام حاوی سه منبع «میانای برنامه‌سازی کاربردی» است.
به‌عنوان ارائه‌دهنده API، شما مسئول ساختن APIها و محصولات API برای مدیریت کنترل دسترسی، محدودیت‌های استفاده، و هرگونه الزامات کسب‌وکار دیگر هستید. برای مثال، ممکن است:
- محصول API رایگانی منتشر کنید که امکان دسترسی فقط خواندنی به منابع API خود را فراهم کند.
- محصول API دومی را با قیمت پایین منتشر کنید که اجازه دسترسی خواندن/نوشتن به همان منابع API نسخه رایگان را می‌دهد اما با محدودیت دسترسی پایین، مثلاً ۱۰۰۰ درخواست در روز.
- محصول API سومی را با قیمت بالاتر عرضه کنید که اجازه دسترسی خواندن/نوشتن به همان منبع API را می‌دهد اما با حد دسترسی بالا.
نکته مهمی که باید به‌خاطر داشته باشید این است که Edge به شما انعطاف‌پذیری لازم را برای ایجاد محصولات API می‌دهد که با الزامات کسب‌وکار APIهای شما مطابقت داشته باشد.
برای کسب اطلاعات بیشتر درباره ایجاد محصولات API، به ایجاد محصولات API مراجعه کنید.
تکلیف ۲: ثبت توسعه‌دهنده برنامه در Edge
توسعه‌دهنده برنامه‌هایی را ایجاد می‌کند که از «میاناهای برنامه‌سازی کاربردی» شما استفاده می‌کنند. توسعه‌دهنده برنامه قبل‌از اینکه بتواند برنامه‌اش را ثبت کند، در Apigee Edge ثبت‌نام می‌کند. وقتی برنامه‌اش را ثبت می‌کند، کلید API دریافت می‌کند که به برنامه امکان دسترسی به API را می‌دهد.
ازطریق فرایند ثبت برنامه، کنترل می‌کنید چه کسی به «میاناهای برنامه‌سازی کاربردی» شما دسترسی داشته باشد. در هر زمانی می‌توانید توسعه‌دهنده نرم‌افزار را حذف کنید، که باعث نامعتبر شدن همه کلیدهای API مرتبط با آن توسعه‌دهنده می‌شود، بنابراین دسترسی آن توسعه‌دهنده به APIهای شما را رد می‌کند.
به‌عنوان ارائه‌دهنده API، شما تصمیم می‌گیرید که توسعه‌دهندگان چگونه ثبت شوند. برای مثال، می‌توانید از فرایند ثبت‌نام دستی استفاده کنید که در آن توسعه‌دهنده بالقوه باید برای ثبت‌نام با سازمان شما تماس بگیرد. توسعه‌دهنده بالقوه باید همه اطلاعات لازم، مثل نشانی ایمیل، نام و نام خانوادگی، و نام شرکت را ارائه دهد. اگر درخواست توسعه‌دهنده را تأیید کنید، می‌توانید از واسط کاربر مدیریت Edge برای ثبت دستی توسعه‌دهنده استفاده کنید. برای اطلاعات بیشتر، مدیریت توسعه‌دهندگان نرم‌افزار را ببینید.
Apigee همچنین ابزارهایی را ارائه می‌دهد که می‌توانید از آن‌ها برای خودکارسازی فرایند ثبت توسعه‌دهنده استفاده کنید. برای مثال:
- از Apigee Edge management API برای ادغام کردن عملکرد ثبت‌نام در وب‌سایت موجودتان استفاده کنید. میانای برنامه‌سازی کاربردی مدیریت Edge یک میانای برنامه‌سازی کاربردی REST است که می‌توانید از آن برای انجام همه جنبه‌های فرایند ثبت توسعه‌دهنده استفاده کنید. برای اطلاعات بیشتر، استفاده از Edge management API برای انتشار میاناهای برنامه‌سازی کاربردی را ببینید.
- برای ثبت توسعه‌دهندگان، از درگاه «خدمات توسعه‌دهندگان Apigee» استفاده کنید. این درگاه از ثبت توسعه‌دهنده پشتیبانی داخلی دارد، اما ویژگی‌های بسیاری دیگری نیز برای پشتیبانی از «میاناهای برنامه‌سازی کاربردی» شما دارد. برای اطلاعات بیشتر، درگاه توسعه‌دهندگان چیست؟ را ببینید.
تکلیف ۳: ثبت برنامه توسعه‌دهنده در Edge
قبل‌از اینکه برنامه‌ای بتواند به «میاناهای برنامه‌سازی کاربردی» شما دسترسی پیدا کند، باید در Edge ثبت شود. بااین‌حال، فقط توسعه‌دهنده ثبت‌شده می‌تواند برنامه‌ای را در Edge ثبت کند.
در زمان ثبت برنامه، توسعه‌دهنده یک یا چند محصول API را انتخاب می‌کند. برای مثال، ممکن است چندین محصول API منتشر کنید که مربوط به انواع مختلف سرویس‌ها و طرح‌های قیمت‌گذاری باشد. توسعه‌دهنده برنامه می‌تواند از فهرست محصولات API دردسترس انتخاب کند.
در پاسخ به ثبت برنامه در Edge، Edge یک کلید API منحصربه‌فرد به برنامه اختصاص می‌دهد. برنامه باید آن کلید API را به‌عنوان بخشی از هر درخواست به منبع API ارسال کند. کلید اصالت‌سنجی می‌شود و، درصورت معتبر بودن، درخواست اعطا می‌شود. در هر زمانی، شما به‌عنوان ارائه‌دهنده سرویس می‌توانید کلید را باطل کنید تا برنامه دیگر نتواند به «میاناهای برنامه‌سازی کاربردی» شما دسترسی داشته باشد.
به‌عنوان ارائه‌دهنده API، شما تصمیم می‌گیرید که چگونه می‌خواهید برنامه‌ها را ثبت کنید. می‌توانید:
- از فرایند دستی استفاده کنید که توسعه‌دهنده را ملزم می‌کند برای ثبت برنامه خود با سازمان شما تماس بگیرد. در پاسخ، کلید API را احتمالاً ازطریق ایمیل برای توسعه‌دهنده ارسال می‌کنید.
- از Edge management API برای ادغام کردن عملکرد ثبت برنامه و ارائه کلید در وب‌سایتتان استفاده کنید.
- برای حساب Edge پولی، از درگاه «خدمات توسعه‌دهنده Apigee» استفاده کنید که از ثبت برنامه و ارائه کلید API پشتیبانی داخلی دارد.
برای اطلاعات بیشتر، ثبت برنامه‌ها و مدیریت کلیدهای API را ببینید.
تکلیف ۴: مستندسازی میاناهای برنامه‌سازی کاربردی
یکی از ملاحظات مهم برای انتشار محصولات API ارائه مستندات و سازوکار بازخورد توسعه‌دهنده است. درگاه‌های توسعه‌دهنده با ویژگی‌های انتشار اجتماعی به‌طور فزاینده‌ای برای ارتباط با انجمن توسعه‌دهندگان استفاده می‌شوند. این شامل انتقال محتوای ایستا، مانند مستندات API و شرایط خدمات، و همچنین محتوای پویا با همیاری انجمن، مانند وبلاگ‌ها و انجمن‌ها، و همچنین ویژگی‌های پشتیبانی مشتری می‌شود.
می‌توانید وب‌سایت خودتان را برای استقرار مستنداتتان بسازید یا، اگر حساب پولی Edge دارید، می‌توانید از درگاه خدمات توسعه‌دهنده Apigee استفاده کنید. این درگاه از مستندات، وبلاگ‌ها، انجمن‌ها، و انواع دیگر محتوای موردنیاز برای پشتیبانی از انجمن توسعه‌دهندگان شما پشتیبانی داخلی دارد.
SmartDocs به شما امکان می‌دهد میاناهای برنامه‌سازی کاربردی خود را در پورتال «خدمات توسعه‌دهندگان» به روشی مستند کنید که اسناد میانای برنامه‌سازی کاربردی کاملاً تعاملی باشد. مستندات تعاملی با SmartDocs یعنی کاربران درگاه می‌توانند:
- درباره میانای برنامه‌سازی کاربردی بخوانید
- ارسال درخواست زنده به API
- مشاهده پاسخ زنده‌ای که از API برگردانده شده است
برای مثال، شکل زیر میانای برنامه‌سازی کاربردی را نشان می‌دهد که بااستفاده از SmartDocs در پورتال مستند شده است. این «میانای برنامه‌سازی کاربردی» اطلاعات آب‌وهوا را برای مکان خاصی ارائه می‌دهد:
توسعه‌دهنده مقداری را برای پارامتر پُرسمان «w» وارد می‌کند تا مکان را مشخص کند، و سپس روی دکمه ارسال درخواست کلیک می‌کند تا درخواست و پاسخ زنده را ببیند. با ایجاد مستندسازی تعاملی برای میاناهای برنامه‌سازی کاربردی خود، یادگیری، آزمایش، و ارزیابی میاناهای برنامه‌سازی کاربردی را برای کاربر درگاه آسان می‌کنید.
Edge management API یک REST API است که به شما امکان می‌دهد بااستفاده از هر کارخواه HTTP به API Services دسترسی داشته باشید. Apigee از SmartDocs برای ایجاد مستندات تعاملی برای «میانای برنامه‌سازی کاربردی مدیریت Edge» استفاده می‌کند. مستندات آن میانای برنامه‌سازی کاربردی را اینجا ببینید.
برای کسب اطلاعات بیشتر، به استفاده از SmartDocs برای مستندسازی میاناهای برنامه‌سازی کاربردی مراجعه کنید.