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

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

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

مقدمه

ثبت برنامه سازوکار اصلی برای کنترل اینکه چه کسی می‌تواند به «میاناهای برنامه‌سازی کاربردی» شما دسترسی داشته باشد را فراهم می‌کند.

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

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

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

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

کاوش صفحه «برنامه‌ها»

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

Edge

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

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

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

همان‌طور که در شکل برجسته شده است، صفحه «برنامه‌ها» به شما امکان می‌دهد:

میانای کاربر Edge جدید (ابر خصوصی)

برای دسترسی به صفحه «برنامه‌ها» بااستفاده از «واسط کاربر Edge جدید»:

  1. در http://host:3001/edge به سیستم «میانای کاربر Edge جدید» وارد شوید. در اینجا، host نشانی IP یا نام ساناد میزبان اجرای «میانای کاربر Edge جدید» است.
  2. در نوار پیمایش سمت راست، انتشار > برنامه‌ها را انتخاب کنید.

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

صفحه «برنامه‌ها» در «واسط کاربر Edge جدید»

همان‌طور که در شکل برجسته شده است، صفحه «برنامه‌ها» به شما امکان می‌دهد:

ثبت برنامه

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

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

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

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

  1. به صفحه «برنامه‌ها» دسترسی پیدا کنید.
  2. روی + برنامه کلیک کنید.
  3. جزئیات برنامه را مشخص کنید:
    فیلد شرح الزامی است؟
    نام نام برنامه. پس‌از ایجاد برنامه نمی‌توانید نام آن را تغییر دهید. این نام در فراخوانی‌های «میانای برنامه‌سازی کاربردی مدیریت» استفاده می‌شود. بله
    نام نمایشی نام نمایشی برنامه که در میانای کاربری مدیریت Edge و درگاه توسعه‌دهنده نشان داده می‌شود. نه
    شرکت/توسعه‌دهنده

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

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

    بله
    نشانی وب پاسخ تماس معمولاً نشانی وب برنامه‌ای را مشخص می‌کند که برای دریافت کد مجوز ازطرف برنامه مشتری تعیین شده است. این مقدار برای همه محصولات «میانای برنامه‌سازی کاربردی» الزامی نیست. نه
    یادداشت‌ها یادداشت‌های توصیفی برای برنامه. نه
  4. اعتبارنامه‌ها، ازجمله وضعیت و انقضای کلید API و محصولات API مرتبط را مشخص کنید.
    در بخش «اطلاعات اعتباری»، روی کلیک کنید و اطلاعات زیر را وارد کنید:
    فیلد شرح
    انقضا مدت یا تاریخ انقضا را پیکربندی کنید، یا کلید API را روی عدم انقضا تنظیم کنید، و روی تأیید کلیک کنید.
    محصولات یک یا چند محصول API را با کلید API مرتبط کنید:
    1. روی افزودن محصول کلیک کنید.
    2. یک یا چند محصول API را از فهرست انتخاب کنید.
    3. روی افزودن کلیک کنید.
    4. وضعیت را برای هر محصول API روی «تأییدشده» یا «لغوشده» تنظیم کنید.
    5. برای افزودن محصولات API بیشتر، مراحل را تکرار کنید.
  5. مشخصه‌های سفارشی را مشخص کنید:
    1. در بخش «مشخصه‌های سفارشی»، روی کلیک کنید.
    2. نام و مقدار را وارد کنید.
    3. روی افزودن یا افزودن و شروع دیگری کلیک کنید.
      حداکثر تعداد ویژگی‌های سفارشی که می‌توانید اضافه کنید ۱۸ است.
  6. روی ایجاد کردن کلیک کنید.

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

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

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

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

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

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

مدیریت اعتبارنامه‌ها

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

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

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

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

برای مشاهده کلید میانای برنامه‌سازی کاربردی و رمز:

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

درحال تأیید یا لغو کردن کلید میانای برنامه‌سازی کاربردی

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

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

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

برای تأیید یا باطل کردن کلید میانای برنامه‌سازی کاربردی:

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

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

با انجام دادن کارهای زیر، محصولات «میانای برنامه‌سازی کاربردی» را در برنامه‌تان مدیریت کنید:

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

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

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

برداشتن محصول API از برنامه

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

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

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

درحال تولید اعتبارنامه‌های جدید

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

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

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

تأیید یا ابطال کردن برنامه

توضیح داده شده است

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

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

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

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

درحال حذف برنامه

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

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

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

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

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

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

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

همچنین ببینید وارد کردن کلیدها و اطلاعات محرمانه مصرف‌کننده موجود.