شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
پورتال های توسعه دهندگان با ویژگی های انتشار اجتماعی به طور فزاینده ای برای ارتباط با جامعه توسعه دهندگان استفاده می شوند. این شامل برقراری ارتباط با محتوای ثابت، مانند اسناد API و شرایط استفاده، و همچنین محتوای پویا مشارکتشده توسط جامعه مانند وبلاگها و انجمنها میشود.
بهعنوان یک ارائهدهنده API، به راهی برای افشای APIهای خود، آموزش توسعهدهندگان در مورد APIهای خود، ثبت نام توسعهدهندگان و اجازه به توسعهدهندگان اجازه ثبت برنامهها نیاز دارید. افشای API های خود در معرض توسعه دهندگان تنها بخشی از ایجاد یک جامعه واقعا پویا است. شما همچنین به راهی برای جامعه توسعهدهندهتان نیاز دارید که بتواند بازخورد ارائه دهد، درخواستهای پشتیبانی و ویژگیها را ارائه کند و محتوای خود را ارسال کند که برای توسعهدهندگان دیگر قابل دسترسی باشد.
Apigee Edge یک پورتال Developer Services را در اختیار شما قرار می دهد که می توانید از آن برای ایجاد و راه اندازی وب سایت سفارشی شده خود برای ارائه همه این خدمات به جامعه توسعه دهنده خود استفاده کنید. هر مشتری Edge میتواند پورتال توسعهدهنده خود را، چه در فضای ابری و چه به صورت آنلاین ایجاد کند.
ویدئوی زیر به معرفی پورتال Apigee Developer Services می پردازد.
شکل زیر صفحه اصلی پورتال پیش فرض توسعه دهنده را نشان می دهد:
پورتال توسعه دهنده اساساً یک سیستم مدیریت محتوا (CMS) بر اساس پروژه منبع باز دروپال ( http://www.drupal.org ) است. دروپال مجموعه ای اصلی از ویژگی ها را در قالب ماژول ها ارائه می دهد که ساخت محتوا و همچنین مدیریت وب سایت ها را برای شما آسان می کند.
خارج از جعبه، پورتال توسعهدهنده به شما امکان میدهد اسناد API ایجاد کنید، از وبلاگنویسی پشتیبانی میکند و تالارهای گفتگوی رشتهای را فراهم میکند. شما همچنین می توانید پورتال توسعه دهنده را سفارشی کنید تا نیازهای خاص خود را برآورده کند. سفارشی سازی به شما امکان می دهد ظاهر پورتال و همچنین نحوه تعامل توسعه دهندگان با پورتال را تغییر دهید.
شما از منوی دروپال برای انجام بیشتر سفارشی سازی استفاده می کنید. اگر به عنوان یک کاربر با امتیازات مدیریت وارد پورتال شوید، منوی دروپال در بالای هر صفحه پورتال ظاهر می شود:
مدیریت فرآیندی را که در آن توسعهدهندگان درخواست دسترسی به پورتال میکنند، نحوه ثبت برنامههایی که به APIهای شما دسترسی دارند، نحوه تخصیص نقشها و مجوزهای خاص به برنامهنویسها و زمان لغو دسترسی برنامهنویس به APIها، و زمان لغو دسترسی برنامهنویس به API را کنترل میکند.
شما همچنین از پورتال توسعه دهنده برای پیکربندی و کنترل درآمدزایی استفاده می کنید. کسب درآمد به توسعه دهندگان امکان دسترسی سلف سرویس به صورتحساب و گزارشها، کاتالوگ و طرحها، و تنظیمات خاص کسب درآمد از طریق پورتال توسعهدهنده را میدهد.
انواع کاربران پورتال
تصویر زیر دو نوع کاربر پورتال را نشان می دهد:
- توسعه دهندگان جامعه کاربرانی را تشکیل می دهند که با استفاده از API های شما برنامه می سازند. توسعه دهندگان برنامه از این پورتال برای اطلاع از API های شما از طریق SmartDocs، ثبت حساب در پورتال، ثبت برنامه هایی که از API های شما استفاده می کنند، برای تعامل با جامعه توسعه دهندگان و مشاهده اطلاعات آماری در مورد استفاده از برنامه خود در داشبورد استفاده می کنند.
- تیم API ارائهدهنده API است که محتوای پورتال را ایجاد میکند، APIهای آنها را در دسترس توسعهدهندگان برنامهها قرار میدهد، اسناد API را ارائه میدهد و مکانیزمی را برای توسعهدهندگان برای ثبت برنامهها و دریافت کلیدهای API فراهم میکند. تیم API پیکربندی اولیه پورتال توسعه دهنده را به صورت زیر انجام می دهد:
- درخواست های خودکار یا دستی برای کلیدهای API را پیکربندی کنید
- اسناد API، انجمن ها و وبلاگ ها را حفظ کنید و به صورت اختیاری همه تغییرات را بازبینی کنید
- رسیدگی به نظرات کاربران و نظارت در انجمن
- برای کنترل دسترسی به ویژگی های پورتال، کنترل دسترسی مبتنی بر نقش (RBAC) را اعمال کنید. به عنوان مثال، یک مدیر می تواند کنترل هایی را فعال کند تا به کاربر ثبت نام شده اجازه دهد تا پست های انجمن ایجاد کند یا از کنسول های آزمایشی استفاده کند.
- اعلانهای ایمیل را برای مدیران و توسعهدهندگان برای ایجاد و تأیید کاربر سفارشی کنید
- فرم های وب مانند صفحات "تماس با ما" را سفارشی کنید
در این شکل نوع سوم کاربر پورتال نشان داده نشده است - مدیر محصول API . مدیر محصول API مسئول تعریف نحوه ساخت پورتال توسط تیم API است، از جمله:
- تعریف نحوه بسته بندی APIها در محصولات
- تعریف قوانین برای تایید اپلیکیشن
- اگر کسب درآمد در پورتال فعال باشد، برنامههای قیمتگذاری و صورتحساب برای محصولات API را تعریف کنید. برای اطلاعات بیشتر در مورد کسب درآمد، به نمای کلی کسب درآمد مراجعه کنید.
سفارشی کردن پورتال توسعه دهنده
بهعنوان یک ارائهدهنده API، نحوه سفارشیسازی پورتال توسعهدهنده را در نظر بگیرید تا بهترین تناسب با APIهای خود را داشته باشد و اطلاعات لازم را برای جامعه توسعهدهندگان خود برای استفاده از APIهای خود ارائه دهید. برخی از ملاحظات برای پورتال سفارشی شما عبارتند از:
- دسترسی آسان به API های خود
- مستندات، مانند راهنماها و اسناد مرجع
- محتوای مشارکتشده توسط جامعه مانند وبلاگها و انجمنهای گفتگو
- کد نمونه
- یک فرآیند ثبتنام آسان که در آن توسعهدهندگان، برنامهها و APIهای جدید میتوانند به سرعت تأیید شوند
- حقوق و اعتبارات مدیریت شده
- کنترل دسترسی چند لایه
- نگاه و احساسی که با سازمان شما مطابقت دارد
پورتال با یک پیکربندی اولیه از پیش تعریف شده است. به عنوان مثال، در خارج از جعبه، پورتال به گونهای پیکربندی شده است که به هر کسی اجازه میدهد به عنوان توسعهدهنده ثبت نام کند، اما یک مدیر باید هر ثبتنام را قبل از اینکه توسعهدهنده بتواند به پورتال وارد شود، تأیید کند. پس از تأیید ثبت نام، توسعهدهنده میتواند برنامهای را برای درخواست کلید API ثبت کند و از پورتال برای دسترسی به منابع API استفاده کند.
مراحل ثبت نام پیش فرض عبارتند از:
- توسعه دهنده از طریق پورتال توسعه دهنده ثبت نام می کند. در پاسخ، پورتال ایمیلی را برای تایید حساب به مدیران ارسال می کند.
- یک مدیر حساب را تأیید می کند و یک ایمیل برای توسعه دهنده ارسال می شود که به آنها اطلاع می دهد که اکنون می توانند وارد شوند.
- توسعه دهنده یک برنامه را ثبت می کند و محصولات API مورد استفاده برنامه را انتخاب می کند. در پاسخ، پورتال یک کلید API منحصر به فرد را به برنامه اختصاص می دهد.
- توسعه دهنده کلید API را هنگام درخواست به API شما ارسال می کند.
این تجربه خارج از جعبه بسیار قابل تنظیم است. برای مثال، میتوانید طرح پیشفرض ثبتنام و مجوز را لغو کنید تا یک توسعهدهنده جدید بهطور خودکار پس از ثبتنام تأیید شده و وارد سیستم شوید. یا، میتوانید از برنامهنویس بخواهید که مجموعهای از شرایط و ضوابط را قبل از اینکه بتواند برای اولین بار وارد سیستم شود، بپذیرد.
شما همچنین کنترل کاملی بر محتوای موجود در پورتال توسعه دهندگان دارید. خارج از جعبه، پورتال توسعهدهنده محتوای نمونه مانند اسناد API، پستهای وبلاگ و بحثهای انجمن را ارائه میکند. شما می توانید محتوای خود را ارائه دهید و ظاهر هر نوع محتوا را سفارشی کنید.
برای اطلاعات بیشتر، به سفارشی کردن ظاهر مراجعه کنید.
مدیریت پورتال توسعه دهنده
توسعه دهندگان از پورتال توسعه دهنده شما برای دسترسی و استفاده از API شما استفاده می کنند. مدیران وظایف مدیریت حساب را انجام می دهند، مانند:
- سفارشی کردن فرآیند ثبت نام توسعه دهنده، از جمله فیلدهای ثبت نام، ساخته شده در Captcha، و تأیید خودکار یا دستی
- افزودن یا تایید توسعه دهندگان بهطور پیشفرض، هر توسعهدهندهای میتواند از طریق پورتال توسعهدهنده ثبتنام کند، اما باید توسط یک مدیر از طریق رابط کاربری Dev Portal تأیید شود. مدیران همچنین می توانند توسعه دهندگان را مستقیماً در پورتال ایجاد کنند. سپس پورتال به طور خودکار به توسعه دهنده ایمیل می گوید که یک حساب برای آنها ایجاد شده است.
- تغییر حساب توسعه دهنده به عنوان مثال، مدیران می توانند وضعیت حساب کاربری کاربر را از فعال به مسدود شده تغییر دهند یا اطلاعات نمایه توسعه دهنده مانند نام شرکت را تغییر دهند.
- حذف یک توسعه دهنده مدیران می توانند حساب توسعه دهنده را غیرفعال یا حذف کنند.
- تخصیص نقش ها و مجوزها: مدیران می توانند نقش خاصی را به حساب توسعه دهنده اختصاص دهند. یک نقش با مجوزهای مختلفی مانند اجازه ایجاد کتاب یا محتوای دیگر مرتبط است. همچنین می توانید مجوزهای مرتبط با یک نقش را تغییر دهید یا نقش های جدیدی ایجاد کنید.
برای اطلاعات بیشتر، به افزودن و مدیریت حسابهای کاربری مراجعه کنید.
خلاصه ای از ویژگی های پورتال توسعه دهندگان
جدول زیر شامل خلاصه ای از ویژگی های پورتال توسعه دهنده است:
ویژگی | جزئیات |
---|---|
پشتیبانی از مرورگر | نرم افزارهای پشتیبانی شده و نسخه های پشتیبانی شده را ببینید. |
ثبت نام کاربر |
|
مدیریت کاربر |
|
ظاهر پورتال |
|
مدیریت محتوا و جامعه |
|
مجوزها |
|
مدیریت کلید API |
|
ایمیل |
|
وبلاگ ها |
|
انجمن ها |
|
مستندات |
|
منوها |
|
جستجو کنید |
|
جستجوگر پیوند |
|