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

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

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

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

برای مرور کلی محصولات API، به بخش «محصول API چیست؟» مراجعه کنید.

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

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

لبه

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

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

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

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

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

لبه کلاسیک (ابر خصوصی)

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

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

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

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

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

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

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

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

    برای مثال، اگر یک پروکسی API مربوط به "موسیقی" را با مسیر پایه /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. (اختیاری) از بخش ویژگی‌های سفارشی برای افزودن حداکثر ۱۸ ویژگی سفارشی به یک محصول API استفاده کنید.

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

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

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

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

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

/v1/weatherapikey

ی

ن

ن

ن

ن

/v1/weatherapikey /

ی

ن

ن

ن

ن

/v1/weatherapikey /1

ی

ی

ی

ن

ن

/v1/weatherapikey /1/

ی

ی

ی

ن

ن

/v1/weatherapikey /1/2

ی

ن

ی

ن

ن

/v1/weatherapikey /1/2/

ی

ن

ی

ی

ن

/v1/weatherapikey /1/2/3/

ی

ن

ی

ی

ی

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

ی

ن

ی

ن

ن

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

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

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

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

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

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

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

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

با Apigee Edge برای فضای ابری عمومی ، Edge موجودیت‌های زیر را حداقل به مدت ۱۸۰ ثانیه پس از دسترسی به آنها در حافظه پنهان (cache) نگه می‌دارد.

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

حذف یک محصول API

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

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

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

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

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

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

برای مرور کلی محصولات API، به بخش «محصول API چیست؟» مراجعه کنید.

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

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

لبه

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

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

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

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

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

لبه کلاسیک (ابر خصوصی)

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

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

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

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

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

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

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

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

    برای مثال، اگر یک پروکسی API مربوط به "موسیقی" را با مسیر پایه /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. (اختیاری) از بخش ویژگی‌های سفارشی برای افزودن حداکثر ۱۸ ویژگی سفارشی به یک محصول API استفاده کنید.

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

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

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

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

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

/v1/weatherapikey

ی

ن

ن

ن

ن

/v1/weatherapikey /

ی

ن

ن

ن

ن

/v1/weatherapikey /1

ی

ی

ی

ن

ن

/v1/weatherapikey /1/

ی

ی

ی

ن

ن

/v1/weatherapikey /1/2

ی

ن

ی

ن

ن

/v1/weatherapikey /1/2/

ی

ن

ی

ی

ن

/v1/weatherapikey /1/2/3/

ی

ن

ی

ی

ی

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

ی

ن

ی

ن

ن

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

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

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

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

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

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

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

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

با Apigee Edge برای فضای ابری عمومی ، Edge موجودیت‌های زیر را حداقل به مدت ۱۸۰ ثانیه پس از دسترسی به آنها در حافظه پنهان (cache) نگه می‌دارد.

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

حذف یک محصول API

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

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

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

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

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

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

برای مرور کلی محصولات API، به بخش «محصول API چیست؟» مراجعه کنید.

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

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

لبه

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

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

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

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

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

لبه کلاسیک (ابر خصوصی)

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

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

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

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

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

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

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

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

    برای مثال، اگر یک پروکسی API مربوط به "موسیقی" را با مسیر پایه /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. (اختیاری) از بخش ویژگی‌های سفارشی برای افزودن حداکثر ۱۸ ویژگی سفارشی به یک محصول API استفاده کنید.

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

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

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

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

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

/v1/weatherapikey

ی

ن

ن

ن

ن

/v1/weatherapikey /

ی

ن

ن

ن

ن

/v1/weatherapikey /1

ی

ی

ی

ن

ن

/v1/weatherapikey /1/

ی

ی

ی

ن

ن

/v1/weatherapikey /1/2

ی

ن

ی

ن

ن

/v1/weatherapikey /1/2/

ی

ن

ی

ی

ن

/v1/weatherapikey /1/2/3/

ی

ن

ی

ی

ی

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

ی

ن

ی

ن

ن

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

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

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

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

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

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

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

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

با Apigee Edge برای فضای ابری عمومی ، Edge موجودیت‌های زیر را حداقل به مدت ۱۸۰ ثانیه پس از دسترسی به آنها در حافظه پنهان (cache) نگه می‌دارد.

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

حذف یک محصول API

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

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

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

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

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

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

برای مرور کلی محصولات API، به بخش «محصول API چیست؟» مراجعه کنید.

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

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

لبه

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

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

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

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

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

لبه کلاسیک (ابر خصوصی)

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

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

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

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

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

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

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

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

    برای مثال، اگر یک پروکسی API مربوط به "موسیقی" را با مسیر پایه /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. (اختیاری) از بخش ویژگی‌های سفارشی برای افزودن حداکثر ۱۸ ویژگی سفارشی به یک محصول API استفاده کنید.

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

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

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

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

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

/v1/weatherapikey

ی

ن

ن

ن

ن

/v1/weatherapikey /

ی

ن

ن

ن

ن

/v1/weatherapikey /1

ی

ی

ی

ن

ن

/v1/weatherapikey /1/

ی

ی

ی

ن

ن

/v1/weatherapikey /1/2

ی

ن

ی

ن

ن

/v1/weatherapikey /1/2/

ی

ن

ی

ی

ن

/v1/weatherapikey /1/2/3/

ی

ن

ی

ی

ی

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

ی

ن

ی

ن

ن

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

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

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

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

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

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

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

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

با Apigee Edge برای فضای ابری عمومی ، Edge موجودیت‌های زیر را حداقل به مدت ۱۸۰ ثانیه پس از دسترسی به آنها در حافظه پنهان (cache) نگه می‌دارد.

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

حذف یک محصول API

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

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

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