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