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

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

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

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

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

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

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

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

چگونه Apigee امنیت را در پورتال یکپارچه خود برطرف می‌کند

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

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

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

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

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

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

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

اطلاعات مربوط به برنامه‌ها و کلیدهای API فقط در Edge ذخیره می‌شوند؛ در پورتال ذخیره نمی‌شوند. وقتی یک کاربر پورتال از پورتال برای مشاهده اطلاعات مربوط به یک برنامه، مثلاً از طریق صفحه My Apps، استفاده می‌کند، پورتال درخواستی را با کلید 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 پشتیبانی می‌کنند.