برقراری ارتباط بین پورتال مبتنی بر دروپال و Edge

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

پورتال Developer Services به عنوان یک مشتری برای Apigee Edge عمل می کند. این بدان معناست که پورتال به عنوان یک سیستم مستقل عمل نمی کند. در عوض، بسیاری از اطلاعات مورد استفاده توسط پورتال در واقع در Edge ذخیره می شود. در صورت لزوم، پورتال یک درخواست HTTP یا HTTPS برای بازیابی اطلاعات از Edge یا ارسال اطلاعات به Edge ارائه می کند.

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

اتصال بین پورتال و Edge را پیکربندی کنید

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

• URL نقطه پایانی Edge
  
  نقطه پایانی پیش‌فرض برای نسخه مبتنی بر ابر Edge https://api.enterprise.apigee.com/v1 است.
  
  برای نصب Private Cloud، URL به این شکل است: http:// EdgePrivateCloudIp :8080/v1 یا https:// EdgePrivateCloudIp : TLSport /v1 .
  
  جایی که EdgePrivateCloudIp آدرس IP سرور Edge Management Server است و TLSport پورت TLS/SSL برای API مدیریت Edge است. به عنوان مثال، 8443.
• نام سازمان Apigee
  
  این نام سازمان شما در Edge است. هنگامی که حساب خود را در Edge ایجاد می کنید، سازمان را راه اندازی می کنید.
• نام کاربری و رمز عبور یک مدیر توسعه دهنده
  
  تماس‌های پورتال به Edge احراز هویت می‌شوند و به کاربری با امتیازات مدیر برنامه‌نویس نیاز دارند. هنگامی که یک پورتال توسعه دهنده برای شما فراهم می شود، نقش مدیر برنامه نویس به سازمان شما اضافه می شود. این نقش، که شامل یک کاربر به نام devadmin+{org_name}@apigee.com می‌شود، صرفاً به منظور اتصال پورتال توسعه‌دهنده شما به سازمان Edge شما است. از آنجایی که پورتال برنامه‌های توسعه‌دهنده Edge، محصولات API و غیره شما را نمایش می‌دهد، باید با برقراری تماس‌های API مدیریتی که نیاز به احراز هویت دارند، با سازمان Edge شما هماهنگ بماند. "کاربر" devadmin مجوزهای لازم را دارد.
  

برای مشاهده اطلاعات اتصال:

1. در منوی مدیریت دروپال، Configuration > Dev Portal > Application Settings را انتخاب کنید.

برای تغییر پیکربندی:

نحوه تغییر پیکربندی به نصب پورتال و نسخه پورتال شما بستگی دارد:

• نصب مبتنی بر ابر پورتال نسخه 15.01.06 و جدیدتر : برای تغییر اطلاعات اتصال باید به پشتیبانی Apigee Edge درخواست دهید. به عنوان مثال، اگر می خواهید نام سازمان را تغییر دهید.
• نصب در محل و پورتال مبتنی بر ابر قبلی نسخه 15.01.06 : اطلاعات اتصال را مطابق شرح زیر تغییر دهید:

1. در منوی مدیریت دروپال، Configuration > Dev Portal Settings را انتخاب کنید.
2. نام سازمان خود را در Management API Organization وارد کنید.
3. URL نقطه پایانی Edge را در URL Endpoint API مدیریت وارد کنید.
4. اطلاعات کاربری سرپرست سازمان را در Endpoint Authenticated User و Authenticated User's Password وارد کنید.
5. برای اطمینان از موفقیت آمیز بودن اتصال، Test Connection را انتخاب کنید.
6. Save Configuration را انتخاب کنید.

اطمینان از دسترسی به Edge از پورتال

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

هم Edge و هم پورتال را می توان در فضای ابری یا prem مستقر کرد و می توانید انواع استقرارها را با هم ترکیب کنید. به عنوان مثال، می توانید هر دو را در ابر، هر دو در prem، یا یکی را در ابر و یکی را در prem مستقر کنید:

• اگر هم پورتال و هم Edge توسط Apigee در فضای ابری مستقر شده باشند ، پس هیچ مشکلی در درخواست از پورتال به Edge وجود ندارد.
• اگر پورتال را در prem مستقر می‌کنید ، پس باید مطمئن شوید که پورتال می‌تواند درخواست‌هایی را برای Edge ارسال کند، صرف نظر از اینکه Edge در فضای ابری یا prem مستقر است.
• اگر Edge را در prem مستقر می کنید ، باید مطمئن شوید که پورتال به Edge دسترسی دارد. این بدان معناست که سرور Edge شما باید درخواست‌های پورتال را بدون توجه به اینکه پورتال در فضای ابری یا prem مستقر شده است بپذیرد.

مدیریت برنامه ها و کلیدهای API از پورتال

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

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

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

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

اگر توسعه‌دهنده برنامه‌ای را اضافه، حذف یا اصلاح کند، پورتال این تغییرات را به Edge ارسال می‌کند.

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

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

در زیر همان برنامه، «برنامه آب و هوای من»، همانطور که برای یک سرپرست در رابط کاربری Edge به نظر می رسد، نشان داده شده است:

مدیریت توسعه دهندگان از پورتال

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

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

• نام کوچک
• نام خانوادگی
• آدرس ایمیل
• اطلاعات اضافی اختیاری از پورتال ارسال می شود

پورتال همان اطلاعات Edge را ذخیره می کند، اما اطلاعات اضافی را نیز ذخیره می کند، از جمله:

• رمز عبور پورتال
• وضعیت حساب پورتال: فعال یا مسدود شده است
• نقش پورتال: کاربر تأیید شده، مدیر، سایر موارد
• مجوزهای مبتنی بر نقش: اقداماتی را که توسعه‌دهنده مجاز است در پورتال انجام دهد را تعیین کنید

هنگامی که یک توسعه دهنده به پورتال وارد می شود، این پورتال است که مسئول احراز هویت توسعه دهنده و اجرای مجوزهای مبتنی بر نقش است.

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

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

همگام سازی توسعه دهندگان برنامه بین پورتال و Edge

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

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

برای همگام سازی پورتال با توسعه دهندگان برنامه در Edge

• به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
• افراد را در منوی مدیریت دروپال انتخاب کنید.
• دکمه Dev Portal Developer Sync را در بالای صفحه انتخاب کنید تا با توسعه دهندگان برنامه در Edge همگام شود.

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

پورتال Developer Services به عنوان یک مشتری برای Apigee Edge عمل می کند. این بدان معناست که پورتال به عنوان یک سیستم مستقل عمل نمی کند. در عوض، بسیاری از اطلاعات مورد استفاده توسط پورتال در واقع در Edge ذخیره می شود. در صورت لزوم، پورتال یک درخواست HTTP یا HTTPS برای بازیابی اطلاعات از Edge یا ارسال اطلاعات به Edge ارائه می کند.

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

اتصال بین پورتال و Edge را پیکربندی کنید

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

• URL نقطه پایانی Edge
  
  نقطه پایانی پیش‌فرض برای نسخه مبتنی بر ابر Edge https://api.enterprise.apigee.com/v1 است.
  
  برای نصب Private Cloud، URL به این شکل است: http:// EdgePrivateCloudIp :8080/v1 یا https:// EdgePrivateCloudIp : TLSport /v1 .
  
  جایی که EdgePrivateCloudIp آدرس IP سرور Edge Management Server است و TLSport پورت TLS/SSL برای API مدیریت Edge است. به عنوان مثال، 8443.
• نام سازمان Apigee
  
  این نام سازمان شما در Edge است. هنگامی که حساب خود را در Edge ایجاد می کنید، سازمان را راه اندازی می کنید.
• نام کاربری و رمز عبور یک مدیر توسعه دهنده
  
  تماس‌های پورتال به Edge احراز هویت می‌شوند و به کاربری با امتیازات مدیر برنامه‌نویس نیاز دارند. هنگامی که یک پورتال توسعه دهنده برای شما فراهم می شود، نقش مدیر برنامه نویس به سازمان شما اضافه می شود. این نقش، که شامل یک کاربر به نام devadmin+{org_name}@apigee.com می‌شود، صرفاً به منظور اتصال پورتال توسعه‌دهنده شما به سازمان Edge شما است. از آنجایی که پورتال برنامه‌های توسعه‌دهنده Edge، محصولات API و غیره شما را نمایش می‌دهد، باید با برقراری تماس‌های API مدیریتی که نیاز به احراز هویت دارند، با سازمان Edge شما هماهنگ بماند. "کاربر" devadmin مجوزهای لازم را دارد.
  

برای مشاهده اطلاعات اتصال:

1. در منوی مدیریت دروپال، Configuration > Dev Portal > Application Settings را انتخاب کنید.

برای تغییر پیکربندی:

نحوه تغییر پیکربندی به نصب پورتال و نسخه پورتال شما بستگی دارد:

• نصب مبتنی بر ابر پورتال نسخه 15.01.06 و جدیدتر : برای تغییر اطلاعات اتصال باید به پشتیبانی Apigee Edge درخواست دهید. به عنوان مثال، اگر می خواهید نام سازمان را تغییر دهید.
• نصب در محل و پورتال مبتنی بر ابر قبلی نسخه 15.01.06 : اطلاعات اتصال را مطابق شرح زیر تغییر دهید:

1. در منوی مدیریت دروپال، Configuration > Dev Portal Settings را انتخاب کنید.
2. نام سازمان خود را در Management API Organization وارد کنید.
3. URL نقطه پایانی Edge را در URL Endpoint API مدیریت وارد کنید.
4. اطلاعات کاربری سرپرست سازمان را در Endpoint Authenticated User و Authenticated User's Password وارد کنید.
5. برای اطمینان از موفقیت آمیز بودن اتصال، Test Connection را انتخاب کنید.
6. Save Configuration را انتخاب کنید.

اطمینان از دسترسی به Edge از پورتال

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

هم Edge و هم پورتال را می توان در فضای ابری یا prem مستقر کرد و می توانید انواع استقرارها را با هم ترکیب کنید. به عنوان مثال، می توانید هر دو را در ابر، هر دو در prem، یا یکی را در ابر و یکی را در prem مستقر کنید:

• اگر هم پورتال و هم Edge توسط Apigee در فضای ابری مستقر شده باشند ، پس هیچ مشکلی در درخواست از پورتال به Edge وجود ندارد.
• اگر پورتال را در prem مستقر می‌کنید ، پس باید مطمئن شوید که پورتال می‌تواند درخواست‌هایی را برای Edge ارسال کند، صرف نظر از اینکه Edge در فضای ابری یا prem مستقر است.
• اگر Edge را در prem مستقر می کنید ، باید مطمئن شوید که پورتال به Edge دسترسی دارد. این بدان معناست که سرور Edge شما باید درخواست‌های پورتال را بدون توجه به اینکه پورتال در فضای ابری یا prem مستقر شده است بپذیرد.

مدیریت برنامه ها و کلیدهای API از پورتال

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

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

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

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

اگر توسعه‌دهنده برنامه‌ای را اضافه، حذف یا اصلاح کند، پورتال این تغییرات را به Edge ارسال می‌کند.

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

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

در زیر همان برنامه، «برنامه آب و هوای من»، همانطور که برای یک سرپرست در رابط کاربری Edge به نظر می رسد، نشان داده شده است:

مدیریت توسعه دهندگان از پورتال

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

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

• نام کوچک
• نام خانوادگی
• آدرس ایمیل
• اطلاعات اضافی اختیاری از پورتال ارسال می شود

پورتال همان اطلاعات Edge را ذخیره می کند، اما اطلاعات اضافی را نیز ذخیره می کند، از جمله:

• رمز عبور پورتال
• وضعیت حساب پورتال: فعال یا مسدود شده است
• نقش پورتال: کاربر تأیید شده، مدیر، سایر موارد
• مجوزهای مبتنی بر نقش: اقداماتی را که توسعه‌دهنده مجاز است در پورتال انجام دهد را تعیین کنید

هنگامی که یک توسعه دهنده به پورتال وارد می شود، این پورتال است که مسئول احراز هویت توسعه دهنده و اجرای مجوزهای مبتنی بر نقش است.

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

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

همگام سازی توسعه دهندگان برنامه بین پورتال و Edge

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

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

برای همگام سازی پورتال با توسعه دهندگان برنامه در Edge

• به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
• افراد را در منوی مدیریت دروپال انتخاب کنید.
• دکمه Dev Portal Developer Sync را در بالای صفحه انتخاب کنید تا با توسعه دهندگان برنامه در Edge همگام شود.