محصولات API را مدیریت کنید

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

همانطور که در این بخش توضیح داده شده است، محصولات API را با استفاده از رابط کاربری مدیریت Apigee Edge مدیریت کنید. برای مدیریت محصول API با استفاده از API، به استفاده از API مدیریت لبه برای انتشار APIها مراجعه کنید.

برای یادگیری نحوه ایجاد یک محصول API، ویدیوی زیر را تماشا کنید.

برای مروری بر محصولات API، نگاه کنید به محصول API چیست؟ .

صفحه محصولات API را کاوش کنید

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

لبه

برای دسترسی به صفحه محصولات API با استفاده از رابط کاربری Edge:

  1. به https://apigee.com/edge وارد شوید.
  2. انتشار > محصولات API را انتخاب کنید.

صفحه محصولات API نمایش داده می شود.

صفحه محصولات API که لیست محصولات API را نمایش می دهد. فراخوان‌ها ارائه شده‌اند که وظایفی را که می‌توانید انجام دهید، در زیر شکل فهرست شده‌اند.

همانطور که در شکل قبل نشان داده شده است، صفحه محصولات API شما را قادر می سازد تا وظایف زیر را که در ادامه در این بخش توضیح داده شده است، انجام دهید:

Classic Edge (ابر خصوصی)

برای دسترسی به صفحه محصولات API با استفاده از رابط کاربری Classic Edge:

  1. به http:// ms-ip :9000 وارد شوید، جایی که ms-ip آدرس IP یا نام DNS گره مدیریت سرور است.
  2. انتشار > محصولات را انتخاب کنید.

صفحه محصولات API شما را قادر می سازد تا وظایف زیر را که در ادامه در این بخش توضیح داده شده است انجام دهید:

افزودن یک محصول API

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

برای افزودن یک محصول API با استفاده از رابط کاربری Edge:

  1. همانطور که قبلا در این بخش توضیح داده شد، به صفحه محصولات API دسترسی پیدا کنید .
  2. روی +API Product کلیک کنید.
  3. جزئیات محصول را برای محصول API خود وارد کنید.
    میدان توضیحات
    نام نام داخلی محصول API. پس از ایجاد محصول API نمی توانید نام را ویرایش کنید. در نام کاراکترهای خاص را مشخص نکنید.
    نام نمایشی نام نمایشی برای محصول API. نام نمایشی در رابط کاربری استفاده می‌شود و می‌توانید در هر زمان آن را ویرایش کنید. اگر مشخص نشده باشد، از مقدار Name استفاده خواهد شد. این فیلد با استفاده از مقدار Name به صورت خودکار پر می شود. می توانید محتوای آن را ویرایش یا حذف کنید. نام نمایشی می تواند شامل کاراکترهای خاص باشد.
    توضیحات توضیحات محصول API.
    محیط زیست محیط هایی که محصول API اجازه دسترسی به آنها را می دهد. به عنوان مثال، test یا prod .
    دسترسی داشته باشید سطح دسترسی برای جزئیات، سطح دسترسی را ببینید.
    تأیید خودکار درخواست های دسترسی تأیید خودکار درخواست‌های کلیدی را برای این محصول API از هر برنامه فعال کنید. برای نیاز به تأیید دستی کلیدها، این گزینه را غیرفعال کنید. به ثبت برنامه ها و مدیریت کلیدهای API (UI) و کلیدهای برنامه توسعه دهنده (API) مراجعه کنید.
    سهمیه محدودیت سهمیه ای که می خواهید از خط مشی های سهمیه به آن اشاره کنید. وارد کردن مقدار سهمیه به‌طور خودکار محدودیت‌هایی را برای تعداد تماس‌هایی که می‌توان از طریق محصول انجام داد اعمال نمی‌کند. پراکسی‌های API که محصول به آنها ارجاع می‌دهد باید شامل خط‌مشی Quota برای اجرای سهمیه باشد. برای اطلاعات بیشتر، به سهمیه ها مراجعه کنید.
    محدوده های OAuth مجاز اگر از OAuth با محصول API استفاده می‌کنید، محدوده‌های OAuth مجاز هستند که می‌خواهید محصول API اجازه دهد (مانند خواندن یا سایر حوزه‌هایی که برنامه‌ها با تماس‌های API خود ارسال می‌کنند). چندین محدوده را به عنوان یک لیست جدا شده با کاما مشخص کنید. به دامنه های OAuth مراجعه کنید.

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

    به عنوان مثال، اگر یک پروکسی API "music" را به محصول با مسیر پایه /music اضافه کنید، محصول API امکان تماس با /music را می دهد. با این حال، اگر می‌خواهید محصول API اجازه دسترسی به مسیر منبع venues را بدهد که دارای یک URI از /music/venues است، مسیر منبع /venues را به محصول اضافه کنید. در این صورت، تماس با /music/venues?name=paramount مجاز است، اما تماس با /music/artists?name=Jack%Johnson مسدود خواهد شد.

    یک مسیر منبع خاص را تنظیم کنید یا مسیر پایه و همه مسیرهای فرعی ممکن را با تعیین مسیر منبع به صورت / تنظیم کنید. مسیر منبع می تواند شامل حروف عام /** و /* باشد. علامت علامت دو ستاره نشان می دهد که همه مسیرهای فرعی مسیر پایه پشتیبانی می شوند (اما نه مسیر پایه). یک ستاره نشان می دهد که فقط URI ها یک سطح پایین تر از مسیر پایه پشتیبانی می شوند. به پیکربندی رفتار مسیر منبع '/'، '/*'، و '/**' ، همانطور که بعدا در این بخش توضیح داده شد، مراجعه کنید.

    برای افزودن منابع API:

    1. روی افزودن پروکسی یا افزودن مسیر در بخش منابع API کلیک کنید.
    2. انتخاب کنید که آیا می خواهید یک پروکسی API , مسیر یا هر دو پروکسی API و مسیر اضافه کنید .

      بخش افزودن منبع API به شما امکان می دهد یک پروکسی API، مسیر منبع یا هر دو را اضافه کنید.

    3. یک یا چند پروکسی API و مسیرهای منبع اضافه کنید.

      به موارد زیر توجه کنید:

      • مسیرهای منبعی که شما تعریف می کنید برای همه پراکسی های API اضافه شده به محصول API اعمال می شود.
      • مسیرهای منابع فراگیرتر و کمتر خاص بر مسیرهایی که خاص تر هستند ارجحیت دارند. برای مثال، اگر / و /** را اضافه کنید، مسیر منبع / اولویت دارد. مسیر منبع /** نادیده گرفته خواهد شد.

      به عنوان مثال:

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

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

  6. (اختیاری) از بخش ویژگی های سفارشی برای اضافه کردن 18 ویژگی سفارشی به یک محصول API استفاده کنید.

    ویژگی‌های سفارشی جفت‌های کلید/مقدار هستند که می‌توانند به روش‌های مختلفی استفاده شوند، از جمله کمک به کنترل اجرای پروکسی API. به عنوان مثال، می توانید یک ویژگی سفارشی به نام deprecated با مقدار true یا false ایجاد کنید. در جریان پروکسی API خود، می توانید مقدار ویژگی deprecated محصول API را بررسی کنید (به عنوان مثال، با استفاده از متغیر verifyapikey.{policy_name}.apiproduct.deprecated که پس از ایجاد ویژگی سفارشی به طور خودکار در دسترس است). اگر مقدار آن درست است (منسوخ شده)، می توانید با خط مشی Raise Fault خطایی ایجاد کنید.

  7. روی ذخیره کلیک کنید.

پیکربندی رفتار مسیر منبع '/'، '/*' و '/**'

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

URI را درخواست کنید مجاز برای / مجاز برای /* مجاز برای /** مجاز برای /*/2/** مجاز برای /*/2/*

/v1/weatherapikey

Y

ن

ن

ن

ن

/v1/weatherapikey /

Y

ن

ن

ن

ن

/v1/weatherapikey /1

Y

Y

Y

ن

ن

/v1/weatherapikey /1/

Y

Y

Y

ن

ن

/v1/weatherapikey /1/2

Y

ن

Y

ن

ن

/v1/weatherapikey /1/2/

Y

ن

Y

Y

ن

/v1/weatherapikey /1/2/3/

Y

ن

Y

Y

Y

/v1/weatherapikey /1/a/2/3/

Y

ن

Y

ن

ن

به طور پیش فرض، یک مسیر منبع / در یک محصول API از مسیر پایه و همه مسیرهای فرعی پشتیبانی می کند. به عنوان مثال، اگر مسیر پایه پروکسی API /v1/weatherapikey باشد، محصول API از درخواست‌های /v1/weatherapikey و هر مسیر فرعی مانند /v1/weatherapikey/forecastrss ، /v1/weatherapikey/region/CA پشتیبانی می‌کند. ، و غیره.

می‌توانید این پیش‌فرض را طوری تغییر دهید که مسیر منبع / فقط با مسیر پایه پروکسی API مطابقت داشته باشد، به این معنی که محصول API اجازه دسترسی به یک URI را نمی‌دهد که چیزی بعد از / دارد. اگر این تغییر را انجام دهید، در جدول بالا، فقط دو سطر اول زیر "مجاز برای /" حاوی "Y" خواهد بود.

برای تغییر پیش‌فرض، یک مدیر سیستم باید مقدار ویژگی features.isSingleForwardSlashBlockingEnabled در سازمان شما را روی true تنظیم کند. مشتریان Cloud می توانند این درخواست را به پشتیبانی Apigee Edge ارسال کنند.

ویرایش یک محصول API

برای ویرایش یک محصول API:

  1. همانطور که قبلا در این بخش توضیح داده شد، به صفحه محصولات API دسترسی پیدا کنید .
  2. در ردیف محصول API که می خواهید ویرایش کنید کلیک کنید.
  3. در صفحه محصول API روی Edit کلیک کنید.
  4. فیلدها را در صورت لزوم ویرایش کنید.

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

  5. روی ذخیره کلیک کنید.

با Apigee Edge for Public Cloud ، Edge موجودیت های زیر را حداقل 180 ثانیه پس از دسترسی به موجودیت ها در حافظه پنهان نگه می دارد.

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

حذف یک محصول API

قبل از اینکه بتوانید یک محصول API را حذف کنید، باید هر گونه برنامه توسعه دهنده مرتبط با محصول را لغو ثبت/ارتباط کنید. می‌توانید این کار را با حذف برنامه‌ها یا لغو کلیدهای API برنامه انجام دهید.

برای حذف یک محصول API:

  1. همانطور که قبلا در این بخش توضیح داده شد، به صفحه محصولات API دسترسی پیدا کنید .
  2. مکان نما را روی محصول API در لیست قرار دهید.
  3. کلیک کنیدنماد حذف .
  4. برای تایید عملیات حذف روی Delete کلیک کنید.