پیکربندی ثبت برنامه

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

برنامه نویسان از صفحه My Apps در پورتال Developer Services برای ثبت برنامه ها استفاده می کنند. توسعه دهندگان از منوی اصلی پورتال به صفحه برنامه های من دسترسی پیدا می کنند:

برای ثبت یک برنامه جدید، برنامه‌نویس دکمه افزودن یک برنامه جدید را در صفحه برنامه‌های من انتخاب می‌کند.

سپس پورتال فرم ثبت نام پیش فرض برنامه را نمایش می دهد:

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

به عنوان یک ارائه دهنده API، شما کنترل کاملی بر روند ثبت برنامه دارید. به عنوان مثال، می توانید پیکربندی کنید:

  • لیست محصولات API موجود در پورتال
  • اینکه آیا یک محصول API پیش‌فرض وجود دارد یا خیر
  • آیا نشانی وب پاسخ به تماس مورد نیاز است یا خیر
  • اینکه آیا کلید API به صورت دستی یا خودکار برای یک محصول API تأیید شده است
  • اینکه آیا اطلاعات دیگری در صفحه افزودن برنامه برای ثبت برنامه مورد نیاز است یا خیر

این مبحث نحوه پیکربندی فرآیند ثبت برنامه برای پورتال خود را شرح می دهد. با این حال، این مبحث نحوه ایجاد محصولات API را توضیح نمی دهد. برای اطلاعات بیشتر، نگاه کنید به:

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

مشخص کردن محصولات API موجود در پورتال

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

تعیین سطح دسترسی هنگام ایجاد یک محصول API

هنگامی که یک محصول API ایجاد می کنید، گزینه سطح دسترسی محصول را مانند شکل زیر مشخص می کنید:

برای اطلاعات بیشتر در مورد اینکه چگونه سطح دسترسی بر در دسترس بودن محصول API در پورتال توسعه‌دهنده دروپال 7 تأثیر می‌گذارد، سطح دسترسی را ببینید.

محدود کردن دسترسی به یک محصول API بر اساس نقش‌ها

با فعال کردن ماژول API Product Role Access Drupal، می توانید نقش هایی را مشخص کنید که می توانند به هر محصول API دسترسی داشته باشند.

برای محدود کردن دسترسی به یک محصول API بر اساس نقش های توسعه دهنده:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. نقش های پورتال توسعه دهنده و تکالیف کاربر را مرور کنید:
    • افراد > مجوزها > نقش ها را در منوی مدیریت دروپال انتخاب کنید و نقش ها و مجوزهای توسعه دهنده را در صورت نیاز اضافه یا ویرایش کنید.
    • افراد را در منوی مدیریت دروپال انتخاب کنید و تکالیف کاربر و نقش را در صورت نیاز ویرایش کنید.
  3. Configuration > Dev Portal > API Product Role Access را در منوی مدیریت دروپال انتخاب کنید.
  4. نقش هایی را انتخاب کنید که می خواهید به هر محصول API دسترسی داشته باشید.
  5. روی Save configuration کلیک کنید.

پیکربندی نحوه مرتبط کردن محصولات API توسط برنامه‌نویس با یک برنامه

برای ثبت یک برنامه جدید، یک توسعه دهنده دکمه افزودن یک برنامه جدید را در صفحه برنامه های من انتخاب می کند تا فرم افزودن برنامه را باز کند:

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

گزینه های پیکربندی زیر در پورتال برای کنترل انتخاب محصول API هنگام ثبت برنامه موجود است:

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

همچنین می‌توانید عنصر HTML را که در فرمی که توسعه‌دهنده برای انتخاب محصول API استفاده می‌کند، ظاهر می‌شود، کنترل کنید. گزینه ها عبارتند از:

  • لیست های کشویی
  • چک باکس ها یا دکمه های رادیویی. هنگامی که برنامه‌نویس می‌تواند چندین محصول API را انتخاب کند، کادرهای انتخاب ظاهر می‌شوند و زمانی که توسعه‌دهنده می‌تواند تنها یک محصول API را انتخاب کند، دکمه‌های رادیویی ظاهر می‌شوند.

برای تنظیم گزینه انتخاب محصول API:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. در منوی مدیریت دروپال ، Configuration > Dev Portal Settings > Application Settings را انتخاب کنید.
  3. در صفحه تنظیمات برنامه، قسمت تنظیمات محصول API را گسترش دهید.
  4. در زیر API Product Handling ، گزینه ای را انتخاب کنید که انتخاب محصول API را کنترل می کند.
  5. اگر گزینه «ارتباط همه برنامه‌ها با یک یا چند محصول پیش‌فرض API (پیکربندی شده در زیر)» را مشخص کرده‌اید، یک محصول پیش‌فرض را در قسمت Default API Product تنظیم کنید.
  6. در بخش ابزارک محصول API ، عنصر HTML مورد استفاده توسعه دهندگان را برای انتخاب محصولات API انتخاب کنید.
  7. پیکربندی را ذخیره کنید.

در حال پیکربندی مدیریت URL بازگشت به تماس

اگر یک پروکسی API در محصول API شما از «OAuth سه پایه» (نوع اعطای کد مجوز) استفاده می‌کند، توسعه‌دهندگان باید هنگام ثبت برنامه‌های خود، نشانی وب پاسخ به تماس را مشخص کنند. URL برگشت به تماس معمولاً نشانی اینترنتی برنامه ای را مشخص می کند که برای دریافت کد مجوز از طرف برنامه مشتری تعیین شده است. علاوه بر این، این رشته URL برای اعتبارسنجی استفاده می شود. هنگام درخواست کدهای مجوز و نشانه های دسترسی، مشتری باید این URL را به Apigee Edge ارسال کند و پارامتر redirect_uri باید با پارامتری که ثبت شده مطابقت داشته باشد. برای اطلاعات بیشتر، به اجرای نوع اعطای کد مجوز مراجعه کنید.

برای کنترل URL برگشت به تماس برای انتخاب محصول API:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. Configuration > Dev Portal Settings > Application Attributes را در منوی مدیریت دروپال انتخاب کنید.
  3. در صفحه تنظیمات برنامه، ناحیه تنظیمات URL بازگشت به تماس را گسترش دهید.
  4. در زیر Callback URL Handling ، یکی از گزینه های زیر را انتخاب کنید.
    • URL بازگشت به تماس برای همه برنامه‌های برنامه‌نویس مورد نیاز است.
    • URL بازگشت به تماس برای همه برنامه های توسعه دهنده اختیاری است.
    • URL بازگشت به تماس نه مورد نیاز است و نه نمایش داده می شود.
  5. پیکربندی را ذخیره کنید.

نمایش تجزیه و تحلیل برای استفاده از برنامه

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

  • توان عملیاتی
  • حداکثر زمان پاسخگویی
  • حداقل زمان پاسخگویی
  • تعداد پیام ها
  • شمارش خطا

برای فعال کردن تجزیه و تحلیل در پورتال:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. Configuration > Dev Portal > Application Settings را در منوی مدیریت دروپال انتخاب کنید.
  3. در صفحه تنظیمات برنامه، قسمت تنظیمات عملکرد برنامه را گسترش دهید.
  4. گزینه Show Developer App analytics را انتخاب کنید.
  5. برای پرس و جو برای داده های تجزیه و تحلیل، تست یا Production for Environment را انتخاب کنید. برای یک پورتال در دسترس عموم، معمولاً تولید را انتخاب می‌کنید.
  6. پیکربندی را ذخیره کنید.

برای نمایش تجزیه و تحلیل در پورتال یک برنامه:

  1. نام برنامه را در صفحه برنامه های من انتخاب کنید.
  2. پیوند Analytics را برای برنامه انتخاب کنید.
  3. نوع تجزیه و تحلیل برای نمایش و محدوده تاریخ را انتخاب کنید:
  4. اطلاعات انتخاب شده ظاهر می شود:

تأیید یا لغو دستی یک کلید API برای یک محصول API

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

هنگام ایجاد محصول API، فرآیند تأیید کلید برای هر محصول API را کنترل می کنید:

فرآیند تایید می تواند به شرح زیر باشد:

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

برای اطلاعات بیشتر به ایجاد محصولات API مراجعه کنید.

اگر پورتال شما به یک برنامه‌نویس اجازه می‌دهد چندین محصول API را به یک برنامه اضافه کند، ممکن است برنامه‌نویس برخی از محصولات را با تأیید کلید خودکار و برخی را با دستی اضافه کند. توسعه‌دهنده می‌تواند بلافاصله از کلید API برگشتی برای همه محصولات API تأیید شده خودکار استفاده کند، در حالی که منتظر تأیید نهایی برای آن دسته از محصولاتی است که نیاز به تأیید دستی دارند.

برای مشاهده لیست محصولات API برای یک برنامه، و وضعیت تأیید کلید برای محصول API، یک برنامه‌نویس نام برنامه را در صفحه برنامه‌های من انتخاب می‌کند و سپس پیوند محصولات را انتخاب می‌کند:

در این مثال، محصول Premium Weather API از تأیید دستی استفاده می‌کند و منتظر است تا مدیر کلید را تأیید کند. محصول رایگان API از تأیید خودکار استفاده می کند و استفاده از کلید برای دسترسی به آن تأیید شده است.

برای تأیید یا لغو دستی یک کلید:

  1. به عنوان کاربر دارای امتیاز مدیریت برای سازمان خود وارد رابط کاربری Edge management شوید.
  2. API Platform را در کادر کشویی در گوشه سمت راست بالا انتخاب کنید.
  3. برای باز کردن لیست برنامه های توسعه دهنده ، انتشار > برنامه های توسعه دهنده را انتخاب کنید.
  4. برای مشاهده لیست برنامه هایی که درخواست های کلیدی معلق دارند، دکمه در انتظار را انتخاب کنید:

  5. نام برنامه ای را که می خواهید تأیید کنید انتخاب کنید.
  6. در صفحه جزئیات برنامه، دکمه ویرایش را در گوشه سمت راست بالا انتخاب کنید.
  7. در لیست محصولات API برای برنامه، در بخش Actions :
    • برای تأیید کلید ، دکمه تأیید را برای هر محصول API که نیاز به تأیید دستی دارد، انتخاب کنید.

    • برای لغو یک کلید تایید شده ، دکمه Revoke را در زیر Actions برای یک محصول API برای لغو دسترسی انتخاب کنید.

  8. برنامه را ذخیره کنید. کلید API اکنون تأیید شده است.

کنترل حافظه پنهان محصول و برنامه API

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

برای اطمینان از هماهنگی پورتال با بک‌اند Edge، می‌توانید به‌طور دستی به‌روزرسانی حافظه پنهان پورتال را راه‌اندازی کنید، زمانی که کار cron پورتال اجرا می‌شود، کش‌ها را به‌طور خودکار به‌روزرسانی کنید، یا هر دو. به عنوان مثال، اگر cron job را به گونه‌ای پیکربندی کنید که به طور مکرر اجرا شود، مثلاً هر 5 یا 10 دقیقه، ممکن است نیازی به هزینه‌های سربار به‌روزرسانی محصولات API و حافظه پنهان برنامه توسعه‌دهنده نداشته باشید. در این شرایط، می توانید به روز رسانی کش را به صورت دستی فعال کنید. اما، اگر cron job هر ساعت یا دو ساعت اجرا شود، زمان لازم برای به روز رسانی کش ها ممکن است تاثیر زیادی نداشته باشد.

به طور پیش فرض، پورتال به گونه ای پیکربندی شده است که هر بار که cron اجرا می شود، حافظه پنهان محصول API و برنامه توسعه دهنده را بازسازی کند.

برای تعیین اینکه آیا هر بار که cron اجرا می شود، حافظه پنهان محصول API و برنامه توسعه دهنده بازسازی شود یا خیر:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. از منوی دروپال، Configuration > Dev Portal Settings > Application Settings را انتخاب کنید.
  3. هر بار که cron اجرا می شود، تیک Rebuild API Product and Developer App and Developer Cache را علامت بزنید یا بردارید.
  4. تنظیمات خود را ذخیره کنید.

برای به روز رسانی کش ها به صورت دستی:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. از منوی دروپال، نماد Home > Flush all cache را انتخاب کنید.

سفارشی کردن فیلدهای فرم مورد استفاده برای ثبت برنامه

هنگامی که توسعه دهنده یک برنامه را ثبت می کند، پورتال فرم پیش فرض را نشان می دهد:

به‌عنوان یک ارائه‌دهنده API، ممکن است بخواهید این فرم را تغییر دهید تا از برنامه‌نویس بخواهید اطلاعات بیشتری مانند شناسه مشتری، پلتفرم هدف برنامه یا اطلاعات دیگر را ارائه کند. پورتال امکان افزودن فیلدهای جدید به این فرم را در اختیار شما قرار می دهد. این فیلدها می توانند:

  • الزامی یا اختیاری
  • توسط عناصر مختلف HTML مانند جعبه‌های متن، دکمه‌های رادیویی، چک باکس‌ها و موارد دیگر نمایش داده می‌شود
  • می توان تنظیم کرد که در هر جایی از فرم بین فیلد URL برگشت به تماس و قسمت محصول ظاهر شود

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

به عنوان مثال، فرم زیر یک فیلد الزامی برای شناسه مشتری و یک فیلد اختیاری برای پلتفرم هدف را نشان می‌دهد:

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

برای مثال، با رفتن به Publish > Developer Apps، و سپس انتخاب نام برنامه، فیلدهای فرم جدید را در رابط کاربری Edge management مشاهده کنید. مقادیر فیلد جدید در قسمت ویژگی های سفارشی صفحه با نامی که با نام داخلی فیلد مطابقت دارد ظاهر می شود:

مقادیر فیلد نیز در قسمت جزئیات برنامه در صفحه برنامه‌های من توسعه‌دهنده نمایش داده می‌شوند:

برنامه‌نویس همچنین می‌تواند با انتخاب پیوند ویرایش برای برنامه در صفحه برنامه‌های من، مقادیر را ویرایش کند.

مراحل زیر نحوه پیکربندی فرم‌های ایجاد برنامه را با استفاده از رابط مدیر توضیح می‌دهد. یک توسعه‌دهنده دروپال می‌تواند سفارشی‌سازی‌های اضافی، از جمله اصلاح صفحه «برنامه‌های من» را با استفاده از قلاب‌های سفارشی انجام دهد. برای کسب اطلاعات بیشتر در مورد نحوه تغییر رفتارها از طریق کد، نمونه‌های API برنامه را در فایل ببینید: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php .

برای افزودن یک فیلد به فرم ثبت نام برنامه:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. مطمئن شوید که ماژول DevConnect App Attribute Management فعال است.
  3. Configuration > Dev Portal Settings > Dev Portal App Attributes را در منوی مدیریت دروپال انتخاب کنید.
  4. دکمه Add Dev Portal App Attribute را در بالای صفحه انتخاب کنید.
  5. فیلد را پیکربندی کنید. به عنوان مثال، برای قسمت شناسه مشتری نشان داده شده در بالا، از تنظیمات زیر استفاده کنید:
    • نام داخلی = cust_id. این نام متغیری است که برای ذخیره مقدار فیلد استفاده می شود.
    • نام عمومی = شناسه مشتری
    • توضیحات = شناسه مشتری خود را وارد کنید.
    • چک باکس Require this feature را انتخاب کنید
    • کادر را برای نمایش این ویژگی انتخاب کنید.
    • ویجت = جعبه متن
    • ذخیره را انتخاب کنید تا به صفحه ویژگی های برنامه Dev Portal برگردید.
  6. ذخیره تغییرات را انتخاب کنید.
  7. نماد Home > Flush all cache را از منوی Drupal انتخاب کنید.
    ممکن است لازم باشد کش مرورگر خود را قبل از ظاهر شدن فیلد جدید در فرم پاک کنید.

برای افزودن یک فیلد اختیاری برای توسعه دهنده تا پلتفرم برنامه را مشخص کند، ویژگی های فیلد را به صورت زیر تنظیم کنید:

  • نام داخلی = target_platforms
  • نام عمومی = پلتفرم ها
  • توضیحات = یک یا چند پلتفرم برای اپلیکیشن خود مشخص کنید.
  • چک باکس های Require this feature را پاک کنید
  • کادر را برای نمایش این ویژگی انتخاب کنید.
  • ویجت = فهرست چک باکس ها
  • ذخیره را انتخاب کنید تا به صفحه ویژگی های برنامه Dev Portal برگردید.

برای مرتب کردن مجدد صفات در فرم:

  1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
  2. Configuration > Dev Portal Settings > Dev Portal App Attributes را در منوی مدیریت دروپال انتخاب کنید.
  3. نماد مثبت، + ، را در زیر ستون Name انتخاب کنید و ویژگی را به محلی که می خواهید در فرم نمایش دهید بکشید.
  4. تغییرات خود را ذخیره کنید