پورتال یکپارچه خود را بسازید

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

Apigee Edge یک پورتال یکپارچه و با کاربری ساده را برای مستندسازی و مدیریت دسترسی به API های شما و تقویت جامعه توسعه دهندگان برنامه شما ارائه می دهد.

همه کاربران Apigee Edge به ابزارهای توسعه پورتال یکپارچه دسترسی دارند که آنها را قادر می سازد به سرعت پورتال توسعه دهنده خود را بسازند و جایگزینی برای توسعه پورتال مبتنی بر دروپال ارائه دهند. برای مقایسه ویژگی‌ها، به مقایسه ویژگی‌های پورتال توسعه‌دهنده مراجعه کنید.

این ویدئوی کوتاه را برای آشنایی با ساخت و انتشار پورتال یکپارچه خود تماشا کنید.

ویژگی ها و مزایای کلیدی

پورتال یکپارچه ویژگی ها و مزایای کلیدی زیر را در اختیار شما قرار می دهد:
ویژگی مزایا
توسعه محتوای پورتال محتوای پورتال خود را به سرعت و به راحتی توسعه دهید.
  • با استفاده از ویرایشگر صفحه ساده برای استفاده، صفحات ایجاد کنید
  • از Markdown و HTML برای نوشتن محتوا استفاده کنید
  • منوهایی را برای پیمایش در پورتال خود اضافه کنید
ظاهر و احساس پورتال با استفاده از شیوه نامه های SCSS و برندسازی شخصی، ظاهر و ظاهر پورتال خود را کاملا سفارشی کنید.
اسناد API مستندات مرجع API را بر اساس مشخصات OpenAPI خود به طور خودکار ایجاد کنید.
ثبت نام سلف سرویس برای توسعه دهندگان ثبت نام سلف سرویس ارائه دهید تا با استفاده از API های شما برنامه بسازند.
مدیریت مخاطب کنترل کنید چه کسی می تواند به محتوای پورتال و API ها دسترسی داشته باشد
تجزیه و تحلیل Google Analytics و ردیابی تجزیه و تحلیل سفارشی را پیکربندی کنید.
سفارشی سازی های پیشرفته انجام سفارشی سازی های پیشرفته پورتال، از جمله:
  • دامنه خود را سفارشی کنید
  • فیلدهای ثبت سفارشی را اضافه کنید
  • پورتال خود را با استفاده از اسکریپت ها گسترش دهید
  • ایمیل خود را پیکربندی کنید

شروع به ساخت پورتال خود کنید

چگونه Apigee به امنیت در پورتال یکپارچه می پردازد

جدول زیر نحوه پرداختن به امنیت Apigee از طریق ویژگی‌های داخلی در پورتال یکپارچه را شرح می‌دهد.

ویژگی آدرس ها
به HTTPS و امنیت لایه انتقال (TLS) نیاز دارد ارتباطات رمزگذاری شده را اعمال می کند
شامل ثبت دامنه apigee.io با فهرست پسوند عمومی است اجازه نمی‌دهد «ابر کوکی‌ها» در زیر دامنه‌های apigee.io تنظیم شوند
از پیکربندی سیاست امنیتی محتوا (CSP) پشتیبانی می کند از اسکریپت نویسی متقابل سایت (XSS) و سایر حملات تزریق کد محافظت می کند
نیاز دارد:
  • سالم سازی ورودی فرم
  • تزریق جاوا اسکریپت در سراسر سایت به مدیران محدود شده است
 از حملات تزریق HTML، SQL یا backend محافظت می کند
شامل x-content-type-options: nosniff XSS header مرورگرها را از تلاش برای حدس زدن انواع MIME منع می کند
شامل x-frame-options: deny هدر XSS است جاسازی محتوای پورتال در iFrame را ممنوع می کند
شامل x-xss-protection: 1 هدر XSS هنگامی که صفحات اسکریپت بین سایتی (XSS) را شناسایی می کنند، بارگیری را ممنوع می کند
از توکن های CSRF استفاده می کند از جعل درخواست های متقاطع محافظت می کند
اهرم ها: حفاظت از داده های مشتری

نحوه ارتباط پورتال یکپارچه با Edge

اکثر اطلاعات استفاده شده توسط پورتال توسعه دهنده در Apigee Edge ذخیره می شود. پورتال به عنوان مشتری برای Edge عمل می کند. در صورت لزوم، پورتال توسعه دهنده یک درخواست HTTP یا HTTPS REST برای بازیابی اطلاعات یا ارسال اطلاعات از Edge ارسال می کند. به عنوان مثال، هنگامی که یک کاربر پورتال یک برنامه جدید را در پورتال ثبت می کند، پورتال درخواستی را برای ذخیره اطلاعات مربوط به برنامه به Edge ارسال می کند.

بخش های زیر جزئیات بیشتری را ارائه می دهند.

جایی که ثبت برنامه و کلیدهای API ذخیره می شوند

هنگامی که کاربر پورتال فرآیند ثبت برنامه را در پورتال یکپارچه تکمیل می کند، پورتال اطلاعاتی را درباره برنامه به Apigee Edge ارسال می کند، از جمله نام برنامه و محصولات API مرتبط با برنامه. اگر Edge برنامه را با موفقیت ثبت کند، Edge یک کلید API را به پورتال برمی‌گرداند. کاربر پورتال از آن کلید API برای دسترسی به محصولات API مرتبط با برنامه استفاده می کند.

اطلاعات مربوط به برنامه ها و کلیدهای API فقط در Edge ذخیره می شود. در پورتال ذخیره نمی شود. هنگامی که یک کاربر پورتال از پورتال برای مشاهده اطلاعات مربوط به یک برنامه استفاده می کند، برای مثال از طریق صفحه برنامه های من، پورتال برای دسترسی به اطلاعات با کلید API از Edge درخواست می کند.

به طور مشابه، هنگامی که یک کاربر پورتال یک برنامه را اضافه، حذف یا تغییر می دهد، پورتال تغییرات را به Edge ارسال می کند تا ذخیره شود.

از آنجایی که تمام اطلاعات مربوط به برنامه‌ها و کلیدهای API در Edge ذخیره می‌شود، یک سرپرست Edge می‌تواند اطلاعات را با استفاده از رابط کاربری Edge یا مدیریت API تغییر دهد. به عنوان مثال، یک مدیر می تواند:

  • یک برنامه توسعه دهنده را اضافه، حذف یا تغییر دهید
  • یک کلید API برای یک برنامه توسعه دهنده را تأیید یا لغو کنید

برای اطلاعات بیشتر، به ثبت برنامه‌ها و مدیریت کلیدهای API مراجعه کنید.

جایی که اطلاعات حساب برنامه‌نویس برنامه ذخیره می‌شود

اطلاعات حساب توسعه دهنده به شرح زیر در Edge ذخیره می شود:

اطلاعات حساب کاربری زیر در Edge ذخیره می شود:

  • نام و نام خانوادگی
  • آدرس ایمیل
  • نام کاربری
  • وضعیت حساب پورتال (فعال یا غیرفعال)
  • نقش پورتال (کاربر تایید شده، مدیر، سایر موارد)
  • مجوزهای مبتنی بر نقش
  • تیم هایی که کاربر پورتال در آنها عضویت دارد (اگر در نسخه بتا ویژگی تیم ها ثبت نام کرده باشید)

آدرس ایمیل کلید اصلی است که توسط Edge برای شناسایی توسعه دهنده استفاده می شود و هر کدام باید منحصر به فرد باشند. از کلید اصلی، Edge برای هر سازمانی که توسعه دهنده به آن تعلق دارد، یک شناسه توسعه دهنده منحصر به فرد تولید می کند.

برای اطلاعات بیشتر، به ثبت نام توسعه دهندگان برنامه مراجعه کنید.

جایی که اطلاعات تیم توسعه دهنده ذخیره می شود (بتا)

هنگامی که یک تیم توسعه دهنده در پورتال توسط یک کاربر پورتال ایجاد می شود، اطلاعات تیم توسعه دهنده در Edge ذخیره می شود، از جمله:

  • نام و توضیحات تیم توسعه دهنده
  • اعضای تیم توسعه دهنده و نقش آنها
  • برنامه هایی که تیم توسعه دهنده به آنها اختصاص داده شده است
  • مخاطبین اختصاص داده شده به تیم توسعه دهنده
  • زمان ایجاد تیم توسعه دهنده

یک آدرس ایمیل منحصربه‌فرد و خودکار تولید شده برای تیم توسعه‌دهنده ایجاد می‌شود و به عنوان کلید اصلی مورد استفاده توسط Edge برای شناسایی تیم توسعه‌دهنده عمل می‌کند.

برای اطلاعات بیشتر، به اشتراک مسئولیت یک برنامه با استفاده از تیم‌های برنامه‌نویس (بتا) و مدیریت تیم‌های برنامه‌نویس مراجعه کنید.

درباره پورتال نمونه

هنگامی که یک پورتال جدید ایجاد می کنید، مجموعه ای از صفحات آغازین برای شما ارائه می شود تا به عنوان نقطه پرش از آنها استفاده کنید. صفحات آغازین حاوی محتوای نمایشی هستند تا با جایگزین کردن متن و تصاویر با محتوای منحصر به فرد خود، الهام بخش توسعه پورتال شما باشند. تم نمونه پورتال از قالب طرح متریال و SCSS استفاده می کند.

در زیر صفحه اصلی پورتال نمونه نشان داده شده است.

صفحات شروع ارائه شده با پورتال نمونه عبارتند از:

صفحه توضیحات
صفحه اصلی صفحه اصلی پورتال که API های نمایش داده شده را توصیف می کند. به عنوان صفحه اصلی پیش فرض برای پورتال شما (index.html) عمل می کند. استفاده از اجزای مواد زاویه‌دار را نشان می‌دهد، همانطور که در افزودن اجزای مواد زاویه‌دار توضیح داده شده است.
شروع سریع مجموعه ای از مراحل شروع سریع که نحوه سفارشی کردن پورتال را نشان می دهد. روی شروع سریع در پورتال نمونه کلیک کنید تا از طریق افزودن محتوا به صفحه شروع کنید.
شروع کنید صفحه محتوای نمونه. برای یادگیری نحوه ویرایش این صفحه و افزودن آن به پیمایش بالا، به صفحه شروع در پورتال نمونه مراجعه کنید.
API ها لیست API های موجود هنگامی که اسناد مرجع API تعاملی ایجاد می کنید ، پیوندهای محتوا به طور خودکار به این صفحه اضافه می شوند.

توجه: محتویات این صفحه بر اساس APIهایی که در پورتال خود منتشر می کنید به صورت خودکار تولید می شوند. شما نمی توانید محتوای این صفحه را مستقیماً ویرایش کنید. در لیست صفحات ظاهر نمی شود. با استفاده از ویرایشگر تم پورتال می توانید استایل صفحه را تغییر دهید.
برنامه های من لیست برنامه های ثبت شده برای یک کاربر مجاز. نحوه تعامل کاربران پورتال با پورتال شما را ببینید.

توجه: محتویات این صفحه بر اساس برنامه های کاربر ثبت شده به صورت خودکار تولید می شوند. شما نمی توانید محتوای صفحه را مستقیماً ویرایش کنید. در لیست صفحات ظاهر نمی شود. می توانید با استفاده از ویرایشگر تم، استایل صفحه را تغییر دهید.
وارد شوید صفحه ورود به سیستم برای کاربران ثبت نام شده کاربران جدید می توانند با کلیک روی ورود به سیستم از این صفحه ثبت نام کنند. نحوه تعامل کاربران پورتال با پورتال شما را ببینید.

توجه: صفحه ورود به سیستم به صورت خودکار در پورتال شما قرار می گیرد. می توانید آرم را در صفحه ورود به سیستم سفارشی کنید و فیلدهای ثبت سفارشی را به صفحه ایجاد حساب اضافه کنید . شما نمی توانید محتوای صفحه را مستقیماً ویرایش کنید. در لیست صفحات ظاهر نمی شود.
شرایط و ضوابط صفحه نمونه شرایط و ضوابط

پشتیبانی از مرورگر

پورتال های یکپارچه Apigee از همان نسخه های مرورگر Apigee Edge پشتیبانی می کنند.