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

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

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

مقدمه

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

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

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

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

بخش‌های زیر نحوه ثبت برنامه‌ها و مدیریت کلیدهای API با استفاده از UI و API را شرح می‌دهند.

کاوش در صفحه برنامه ها

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

لبه

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

  1. به apigee.com/edge وارد شوید.
  2. انتشار > برنامه ها را در نوار پیمایش سمت چپ انتخاب کنید.

صفحه برنامه ها نمایش داده می شود.

همانطور که در شکل مشخص شده است، صفحه Apps شما را قادر می سازد:

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

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

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

صفحه Developer Apps نمایش داده می شود.

ثبت اپلیکیشن

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

  • یک برنامه‌نویس می‌تواند برنامه را از طریق پورتال شما ثبت کند، همانطور که در نحوه تعامل توسعه‌دهندگان برنامه با پورتال شما توضیح داده شده است.
  • همانطور که در زیر توضیح داده شده است، می توانید یک برنامه را در Edge ثبت کنید. این شما هستید که تعیین کنید چگونه کلید را در اختیار توسعه دهنده برنامه قرار دهید.

برنامه های ثبت شده به موارد زیر اضافه می شوند:

برای ثبت برنامه در Edge:

  1. به صفحه برنامه ها دسترسی پیدا کنید.
  2. روی + برنامه کلیک کنید.
  3. جزئیات برنامه را مشخص کنید:
    میدان توضیحات مورد نیاز؟
    نام نام برنامه پس از ایجاد برنامه نمی توانید نام را تغییر دهید. این نام در تماس های مدیریت API استفاده می شود. بله
    نام نمایشی نام نمایشی برای برنامه ای که در رابط کاربری مدیریت Edge و پورتال توسعه دهنده ظاهر می شود. خیر
    شرکت/توسعه دهنده

    توجه : Apigee هیبرید از برنامه های شرکت پشتیبانی نمی کند. این فیلد اعمال نمی شود.

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

    		 بله
    URL برگشت به تماس معمولاً URL برنامه ای را مشخص می کند که برای دریافت کد مجوز از طرف برنامه مشتری تعیین شده است. این مقدار برای همه محصولات API لازم نیست. خیر
    یادداشت ها یادداشت های توصیفی برای برنامه خیر
  4. اعتبارنامه ها ، از جمله انقضای کلید API و وضعیت و محصولات API مرتبط را مشخص کنید.
    در قسمت Credentials کلیک کنید و اطلاعات زیر را وارد کنید:
    میدان توضیحات
    انقضا مدت زمان یا تاریخ انقضا را پیکربندی کنید یا کلید API را طوری تنظیم کنید که هرگز منقضی نشود و روی OK کلیک کنید.
    محصولات یک یا چند محصول API را با کلید API مرتبط کنید:
    1. روی افزودن محصول کلیک کنید.
    2. یک یا چند محصول API را از لیست انتخاب کنید.
    3. روی افزودن کلیک کنید.
    4. وضعیت را برای هر محصول API روی تایید یا باطل تنظیم کنید.
    5. برای افزودن محصولات API بیشتر مراحل را تکرار کنید.
  5. ویژگی های سفارشی را مشخص کنید:
    1. در قسمت Custom Attributes کلیک کنید .
    2. نام و مقدار را وارد کنید.
    3. روی افزودن یا افزودن و شروع دیگری کلیک کنید.
      حداکثر تعداد ویژگی های سفارشی که می توانید اضافه کنید 18 است.
  6. روی ایجاد کلیک کنید.

اگر محصولات API که با برنامه مرتبط کرده‌اید به تأیید دستی برای کلیدهای API نیاز داشتند، همانطور که در تأیید یا لغو کلیدهای API توضیح داده شده است، آنها را تأیید کنید.

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

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

مشاهده و ویرایش یک برنامه

برای مشاهده و ویرایش یک برنامه:

  1. به صفحه برنامه ها دسترسی پیدا کنید.
  2. روی ردیف برنامه ای که می خواهید مشاهده و ویرایش کنید کلیک کنید.
    جزئیات برنامه نمایش داده می شود.
  3. برای ویرایش یک برنامه، روی ویرایش کلیک کنید.
  4. انجام یک یا چند مورد از وظایف زیر:
  5. روی ذخیره کلیک کنید.

مدیریت اعتبار

همانطور که در شکل زیر نشان داده شده است، هنگام ویرایش یک برنامه ، می توانید اعتبار آن را در بخش اعتبارنامه ها مدیریت کنید:

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

برای استفاده از API برای مدیریت اعتبارنامه ها، بخش های زیر را ببینید:

مشاهده یک کلید و رمز API

برای مشاهده کلید و رمز API:

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

تأیید یا لغو یک کلید API

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

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

می توانید یک کلید API را برای همه یا یک محصول API منفرد لغو کنید. در این حالت، کلید و راز API نامعتبر هستند و نمی‌توان از آنها برای دسترسی به APIها در محصول(های) API مرتبط استفاده کرد. در هر زمان می‌توانید یک کلید API را دوباره تأیید کنید.

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

  1. به صفحه برنامه ها دسترسی پیدا کنید.
  2. روی ردیف برنامه ای که می خواهید مشاهده و ویرایش کنید کلیک کنید.
  3. روی ویرایش کلیک کنید.
  4. یکی از کارهای زیر را انجام دهید:
    • برای تأیید یا لغو یک کلید API برای همه محصولات API مرتبط با یک کلید API، تأیید یا لغو مرتبط با کلید API را انتخاب کنید.
    • برای تأیید یا لغو یک کلید API برای یک محصول API خاص، تأیید شده یا لغو شده را در ستون وضعیت محصول API انتخاب کنید.
  5. روی ذخیره کلیک کنید.

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

با انجام کارهای زیر، محصولات API را در برنامه خود مدیریت کنید:

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

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

  1. به صفحه برنامه ها دسترسی پیدا کنید.
  2. روی ردیف برنامه ای که می خواهید مشاهده و ویرایش کنید کلیک کنید.
  3. روی ویرایش کلیک کنید.
  4. یکی از کارهای زیر را انجام دهید:
    • برای افزودن یک محصول API به یک کلید API جدید، کلیک کنید برای ایجاد یک اعتبار جدید، یک آزمایش را انتخاب کنید و محصول API را به کلید API اضافه کنید.
    • برای افزودن یک محصول API به یک کلید API موجود، در بخش اعتبارنامه، روی افزودن محصول کلیک کنید و محصول API را از لیست کشویی انتخاب کنید.
  5. روی ذخیره کلیک کنید.

حذف یک محصول API از یک برنامه

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

  1. به صفحه برنامه ها دسترسی پیدا کنید.
  2. روی ردیف برنامه ای که می خواهید مشاهده و ویرایش کنید کلیک کنید.
  3. روی ویرایش کلیک کنید.
  4. کلیک کنید در مجاورت محصول API.
  5. روی ذخیره کلیک کنید.

می توانید محصول حذف شده را دوباره اضافه کنید.

ایجاد مدارک جدید

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

برای ایجاد یک کلید API جدید:

  1. به صفحه برنامه ها دسترسی پیدا کنید.
  2. روی ردیف برنامه ای که می خواهید مشاهده و ویرایش کنید کلیک کنید.
  3. روی ویرایش کلیک کنید.
  4. در قسمت Credentials کلیک کنید .
  5. انقضا را مشخص کنید، محصولات API را اضافه کنید و وضعیت آنها را تنظیم کنید.
  6. در صورت لزوم، هر یک از کلیدهای API دیگر را لغو کنید .
  7. روی ذخیره کلیک کنید.

تایید یا لغو یک برنامه

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

اگر برنامه در سازمان های دیگر ثبت شده است، باید آن را در هر یک از آن سازمان ها لغو کنید. ممکن است چند دقیقه طول بکشد تا تغییرات توسط همه پردازشگرهای پیام شناسایی شوند.

برای تأیید یا لغو یک برنامه:

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

حذف یک برنامه

وقتی یک برنامه را حذف می کنید، همه کلیدهای مشتری مرتبط با برنامه ها نامعتبر می شوند. استفاده از کلید نامعتبر در یک درخواست باعث شکست درخواست می شود.

اگر فکر می کنید ممکن است بخواهید در آینده یک برنامه توسعه دهنده را بازگردانید، جایگزینی برای حذف لغو برنامه است.

برای حذف یک برنامه:

  1. به صفحه برنامه ها دسترسی پیدا کنید.
  2. مکان نما را در ردیف برنامه ای که می خواهید حذف کنید قرار دهید.
  3. کلیک کنید در ستون اقدامات

توجه : با Apigee Edge برای Public Cloud، حذف برنامه توسعه دهنده و مصنوعات مرتبط به صورت ناهمزمان انجام می شود. برنامه توسعه دهنده بلافاصله حذف می شود، اما منابع مرتبط با آن برنامه توسعه دهنده، مانند کلیدهای برنامه یا نشانه های دسترسی، ممکن است از چند ثانیه تا چند دقیقه طول بکشد تا به طور خودکار حذف شوند.

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

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

همچنین به وارد کردن کلیدها و اسرار مصرف کننده موجود مراجعه کنید.