ساختن درگاه یکپارچه

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

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

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

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

درگاه یکپارچه ویژگی‌ها و مزایای کلیدی زیر را دراختیارتان قرار می‌دهد:

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

ساختن درگاهتان را شروع کنید

نحوه رسیدگی Apigee به امنیت در درگاه یکپارچه

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

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

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

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

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

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

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

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

به‌همین ترتیب، وقتی کاربر درگاه برنامه‌ای را اضافه، حذف، یا اصلاح می‌کند، درگاه اصلاحات را برای ذخیره شدن به Edge ارسال می‌کند.

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

• افزودن، برداشتن، یا اصلاح کردن برنامه توسعه‌دهنده
• تأیید یا باطل کردن کلید میانای برنامه‌سازی کاربردی برای برنامه توسعه‌دهنده

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

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

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

• بااستفاده از ارائه‌دهنده هویت داخلی، وقتی کاربر درگاه حسابی ایجاد می‌کند، اطلاعات در ارائه‌دهنده هویت ذخیره می‌شود و در صفحه «کاربران» نمایش داده می‌شود.
• بااستفاده از ارائه‌دهنده هویت SAML، وقتی کاربر درگاه به سیستم درگاه وارد می‌شود، سابقه سایه‌ای از اطلاعات در ارائه‌دهنده هویت ذخیره می‌شود و در صفحه «کاربران» نمایش داده می‌شود.
• پس‌از اینکه کاربر درگاه برنامه توسعه‌دهنده را ثبت می‌کند، اطلاعات حساب کاربر با Edge همگام‌سازی می‌شود و در صفحه «توسعه‌دهندگان» دردسترس قرار می‌گیرد.

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

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

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

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

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

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

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

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

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

درباره درگاه نمونه

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

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

صفحه‌های آغازگر ارائه‌شده با درگاه نمونه شامل موارد زیر است:

صفحه	شرح
Home	صفحه اصلی درگاه که «میاناهای برنامه‌سازی کاربردی» نمایش داده‌شده را توصیف می‌کند. به‌عنوان صفحه اصلی پیش‌فرض برای درگاه شما (index.html) عمل می‌کند. استفاده از عناصر angular material را همان‌گونه که در افزودن عناصر angular material توضیح داده شده است نشان می‌دهد.
شروع سریع	مجموعه‌ای از مراحل شروع سریع که نحوه سفارشی‌سازی کردن درگاه را نشان می‌دهد. در درگاه نمونه، روی شروع سریع کلیک کنید تا مراحل افزودن محتوا به صفحه شروع به کار را طی کنید.
شروع کنید	صفحه محتوای نمونه. برای آشنایی با نحوه ویرایش این صفحه و افزودن آن به پیمایش بالا، صفحه شروع به کار را در درگاه نمونه ببینید.
رابط‌های برنامه‌نویسی کاربردی (API)	فهرست میاناهای برنامه‌سازی کاربردی دردسترس. وقتی سند مرجع تعاملی API تولید می‌کنید، پیوندهای محتوا به‌طور خودکار به این صفحه اضافه می‌شود. توجه: محتوای این صفحه براساس میاناهای برنامه‌سازی کاربردی که در درگاهتان منتشر می‌کنید به‌طور خودکار تولید می‌شود. نمی‌توانید محتوای این صفحه را مستقیماً ویرایش کنید؛ این صفحه در فهرست صفحه‌ها نشان داده نمی‌شود. بااستفاده از ویرایشگر زمینه درگاه می‌توانید سبک صفحه را تغییر دهید.
برنامه‌های من	فهرست برنامه‌های ثبت‌شده برای کاربر مجاز. ببینید کاربران درگاه چگونه با درگاه شما تعامل برقرار می‌کنند. توجه: محتوای این صفحه براساس برنامه‌های کاربر ثبت‌شده به‌طور خودکار تولید می‌شود. نمی‌توانید محتوای صفحه را مستقیماً ویرایش کنید؛ این صفحه در فهرست صفحه‌ها نشان داده نمی‌شود. بااستفاده از ویرایشگر زمینه می‌توانید سبک صفحه را تغییر دهید.
ورود به سیستم	صفحه ورود به سیستم برای کاربران ثبت‌شده. کاربران جدید می‌توانند با کلیک کردن روی ورود به سیستم در این صفحه ثبت‌نام کنند. ببینید کاربران درگاه چگونه با درگاه شما تعامل دارند. توجه: صفحه «ورود به سیستم» به‌طور خودکار در درگاه شما گنجانده می‌شود. می‌توانید نشان‌واره را در صفحه «ورود به سیستم» سفارشی‌سازی کنید و فیلدهای ثبت‌نام سفارشی را به صفحه «ایجاد حساب» اضافه کنید. نمی‌توانید محتوای صفحه را مستقیماً ویرایش کنید؛ این صفحه در فهرست صفحه‌ها نشان داده نمی‌شود.
شروط خدمات	صفحه نمونه شرایط خدمات.

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

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