درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
در حالت پیش‌فرض، درگاه توسعه‌دهندگان به کاربران درگاه شما امکان می‌دهد حساب کاربری ایجاد کنند، به سیستم وارد شوند، و برنامه‌هایی را که از میاناهای برنامه‌سازی کاربردی شما استفاده می‌کنند مدیریت کنند.
بخش‌های زیر نحوه تعامل کاربران درگاه با درگاه شما را شرح می‌دهد.
ورود به سیستم درگاه
بخش‌های زیر توضیح می‌دهد که کاربران درگاه چگونه بااستفاده از اعتبارنامه‌های کاربر (ارائه‌دهنده هویت داخلی) یا بااستفاده از SAML (نسخه بتا) به سیستم درگاه یکپارچه وارد می‌شوند.
اگر هر دو ارائه‌دهنده هویت داخلی و SAML را فعال کنید، کاربران درگاه می‌توانند روش ترجیحی خود را برای ورود به سیستم انتخاب کنند.
بااستفاده از اعتبارنامه‌های کاربر (ارائه‌دهنده هویت داخلی) به سیستم درگاه وارد شوید
وقتی ارائه‌دهنده هویت داخلی فعال باشد، کاربران درگاه می‌توانند بااستفاده از اطلاعات اعتباری کاربر (نام کاربری و گذرواژه) به درگاه یکپارچه وارد شوند، همان‌طور که در بخش‌های زیر توضیح داده شده است:
ایجاد حساب کاربری در درگاه یکپارچه
با ارائه‌دهنده هویت داخلی، قبل‌از اینکه کاربران درگاه بتوانند از APIهای شما استفاده کنند، باید در درگاه یکپارچه‌شده حساب کاربری ایجاد کنند.
کاربران درگاه به این صورت در درگاه یکپارچه حساب کاربری ایجاد می‌کنند:
- به درگاه پیمایش کنید.
روی ورود به سیستم کلیک کنید.
صفحه «ورود به سیستم» نمایش داده می‌شود.
روی ایجاد حساب کلیک کنید.
صفحه «ایجاد حساب» نمایش داده می‌شود.
فرم را تکمیل کنید.
باید مقادیر همه فیلدهای الزامی را وارد کنید. گذرواژه‌ها باید حداقل ۸ نویسه داشته باشند و حداقل یکی از موارد زیر را دربرگیرند: عدد، حرف کوچک، حرف بزرگ، و نویسه خاص.
شرایط را مرور کنید و بپذیرید.
روی ایجاد حساب کلیک کنید.
فرم CAPTCHA را تکمیل کنید و روی درستی‌سنجی کلیک کنید (درصورت نمایش).
حساب کاربری ایجاد می‌شود و ایمیل تأییدی ارسال می‌شود.
ظرف ۱۰ دقیقه، روی پیوند موجود در ایمیل تأیید کلیک کنید تا فرایند ثبت‌نام تکمیل شود.
اگر ظرف ۱۰ دقیقه روی پیوند کلیک نکنید، باید مراحل این رویه را برای ایجاد حساب تکرار کنید و دوباره از شما درخواست می‌شود.
به سیستم درگاه یکپارچه (توضیحات در زیر) وارد شوید.
ورود به سیستم درگاه یکپارچه
با ارائه‌دهنده هویت داخلی، پس‌از اینکه کاربران پرتال در پرتال یکپارچه ثبت‌نام کردند و تأیید شدند، بااستفاده از اطلاعات اعتباری خود (نام کاربری و گذرواژه) به سیستم وارد می‌شوند.
کاربران درگاه به این صورت وارد سیستم می‌شوند:
- به درگاه پیمایش کنید.
- روی ورود به سیستم کلیک کنید.
صفحه «ورود به سیستم» نمایش داده می‌شود:
- نشانی ایمیل و گذرواژه را وارد کنید.
- روی ورود به سیستم کلیک کنید.
تغییر دادن گذرواژه
با ارائه‌دهنده هویت داخلی، کاربران درگاه گذرواژه را به این روش تغییر می‌دهند:
- به درگاه پیمایش کنید.
- روی ورود به سیستم کلیک کنید.
- روی بازنشانی گذرواژه کلیک کنید.
- نشانی ایمیل حسابی را که باید بازنشانی شود وارد کنید.
روی ارسال پیوند بازنشانی گذرواژه کلیک کنید.
پیوند بازنشانی گذرواژه به ایمیل ارسال می‌شود.
روی پیوند موجود در ایمیل تأیید کلیک کنید.
گذرواژه جدید را وارد کنید و آن را تأیید کنید.
گذرواژه‌ها باید حداقل ۸ نویسه داشته باشند و حداقل یکی از موارد زیر را دربرگیرند: عدد، حرف کوچک، حرف بزرگ، و نویسه خاص.
روی ایجاد گذرواژه جدید کلیک کنید.
ورود به سیستم درگاه بااستفاده از اصالت‌سنجی SAML (نسخه بتا)
وقتی ارائه‌دهنده هویت SAML فعال باشد، کاربران درگاه بااستفاده از اصالت‌سنجی SAML به درگاه یکپارچه وارد می‌شوند، به این صورت:
- به درگاه پیمایش کنید.
- روی ورود به سیستم کلیک کنید.
روی ورود به سیستم با SAML کلیک کنید.
به ارائه‌دهنده SAML هدایت می‌شوید.
درصورت درخواست، اعتبارنامه‌های ارائه‌دهنده هویت SAML خود را وارد کنید.
مشاهده اسناد مرجع میانای برنامه‌سازی کاربردی
کاربران درگاه می‌توانند اسناد مرجع API را که در درگاهتان منتشر کرده‌اید به روش‌های زیر مشاهده کنند:
- به درگاه پیمایش کنید.
در نوار پیمایش بالا، روی واسط‌های برنامه‌سازی کاربردی کلیک کنید. صفحه «میاناهای برنامه‌سازی کاربردی» نمایش داده می‌شود. برای مثال:
درصورت تمایل، بااستفاده از ابزارهای موجود در قاب سمت راست، فهرست «میاناهای برنامه‌سازی کاربردی» را براساس دسته، عنوان، یا شرح فیلتر کنید.
برای مشاهده مستندات مرجع API، روی کارت API کلیک کنید. مستندات مرجع API نمایش داده می‌شود.
کاربران درگاه می‌توانند درباره میاناهای برنامه‌سازی کاربردی اطلاعات کسب کنند و آن‌ها را امتحان کنند، یا سندی را که برای پرداز کردن مستندات مرجع میانای برنامه‌سازی کاربردی استفاده می‌شود بارگیری کنند. برای اطلاعات بیشتر درباره نحوه ارائه مستندات مرجع API، به انتشار میاناهای برنامه‌سازی کاربردی مراجعه کنید.
بااستفاده از تیم‌های توسعه‌دهنده (نسخه بتا)، مسئولیت برنامه را هم‌رسانی کنید
تیم‌های توسعه‌دهنده به کاربران درگاه امکان می‌دهند مسئولیت یک برنامه را با دیگر کاربران درگاه هم‌رسانی کنند. بخش‌های زیر نحوه ایجاد و مدیریت تیم‌های توسعه‌دهندگان را شرح می‌دهد.
درباره نقش‌های تیم توسعه‌دهنده
جدول زیر نقش‌هایی را که می‌توان به اعضای تیم توسعه‌دهندگان اختصاص داد خلاصه می‌کند:
| نقش | شرح |
|---|---|
| سرپرست برنامه |
|
| مالک | امتیازهای کامل خواندن و نوشتن برای اعضای تیم توسعه‌دهنده، جزئیات تیم توسعه‌دهنده، و برنامه‌ها. |
| بیننده | امتیازهای فقط خواندنی برای اعضای تیم توسعه‌دهنده، جزئیات تیم توسعه‌دهنده، و برنامه‌ها. |
مشاهده صفحه «تیم‌ها»
صفحه «تیم‌ها» تیم‌های توسعه‌دهنده‌ای را که عضو آن‌ها هستید نمایش می‌دهد.
برای دسترسی به صفحه «تیم‌ها»:
- به سیستم درگاه وارد شوید.
- تیم‌ها را از منو کرکره‌ای حساب کاربری در درگاه انتخاب کنید.
صفحه «تیم‌ها» نمایش داده می‌شود و به شما امکان می‌دهد:
- تیم‌های توسعه‌دهنده‌ای را که عضو آن‌ها هستید، ازجمله نام، نقش، فهرست اعضا، و تاریخ ایجاد تیم را مشاهده کنید
- افزودن تیم توسعه‌دهنده
- با کلیک کردن روی ردیف تیم توسعه‌دهنده، می‌توانید عضویت و نقش‌های تیم توسعه‌دهنده را ویرایش کنید، خودتان را از تیم توسعه‌دهنده بردارید، یا تیمی را حذف کنید
افزودن تیم‌های توسعه‌دهنده
برای افزودن تیم توسعه‌دهنده:
- به سیستم درگاه وارد شوید.
- تیم‌ها را از منو کرکره‌ای حساب کاربری در درگاه انتخاب کنید.
- روی + تیم جدید کلیک کنید.
- نام و شرحی وارد کنید.
برای افزودن عضو به تیم توسعه‌دهنده، روی + افزودن عضو دیگر کلیک کنید، نشانی ایمیل کاربر درگاه را وارد کنید، و نقش تیم توسعه‌دهنده را انتخاب کنید.
برای افزودن اعضای بیشتر، تکرار کنید.
برای حذف یک عضو از تیم توسعه‌دهنده، روی
در کنار عضو تیم توسعه‌دهنده‌ای که می‌خواهید حذف کنید کلیک کنید.روی ایجاد کردن کلیک کنید.
ویرایش عضویت و نقش‌های تیم توسعه‌دهنده
برای ویرایش عضویت و نقش‌های تیم توسعه‌دهنده:
- به سیستم درگاه وارد شوید.
- تیم‌ها را از منو کرکره‌ای حساب کاربری در درگاه انتخاب کنید.
- در ردیف تیم توسعه‌دهنده‌ای که می‌خواهید ویرایش کنید و مالک آن هستید کلیک کنید.
یک یا چند مورد از مراحل زیر را انجام دهید:
- نام، شرح، و مخاطب اصلی را ویرایش کنید.
- اعضای تیم توسعه‌دهنده را اضافه یا حذف کنید.
- نقش‌های عضو تیم توسعه‌دهنده را به‌روز کنید.
روی ذخیره کلیک کنید.
حذف خودتان از تیم توسعه‌دهنده
برای برداشتن خودتان از تیم توسعه‌دهنده:
- به سیستم درگاه وارد شوید.
- تیم‌ها را از منو کرکره‌ای حساب کاربری در درگاه انتخاب کنید.
- در ردیف تیم توسعه‌دهنده‌ای که می‌خواهید خودتان را از آن حذف کنید کلیک کنید.
- روی ترک کردن تیم کلیک کنید.
حذف تیم توسعه‌دهنده
برای حذف تیم توسعه‌دهنده:
- به سیستم درگاه وارد شوید.
- تیم‌ها را از منو کرکره‌ای حساب کاربری در درگاه انتخاب کنید.
- در ردیف تیم توسعه‌دهنده‌ای که می‌خواهید حذف کنید کلیک کنید.
- روی
کلیک کنید. - برای تأیید حذف، روی تأیید کلیک کنید.
ثبت برنامه‌ها
برنامه‌های توسعه‌دهنده و برنامه‌های تیم توسعه‌دهنده را، همان‌طور که در بخش‌های زیر توضیح داده شده است، ثبت کنید.
ثبت برنامه‌های توسعه‌دهنده
کاربران درگاه می‌توانند برنامه‌ها را برای استفاده از میاناهای برنامه‌سازی کاربردی که منتشر کرده‌اید ثبت کنند، به این صورت:
- برنامه‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- برای ایجاد برنامه جدید، روی + برنامه جدید کلیک کنید.
- در کادر گفتگوی «برنامه جدید»، نام و شرحی برای برنامه وارد کنید.
مالک برنامه را در فهرست کرکره‌ای مالک انتخاب کنید.
به‌طور پیش‌فرض، شما مالک برنامه هستید. درصورت تمایل، تیم توسعه‌دهنده را از منو کرکره‌ای انتخاب کنید تا مسئولیت برنامه را با سایر اعضای تیم توسعه‌دهنده هم‌رسانی کنید. هم‌رسانی مسئولیت برای برنامه‌ای که از تیم‌های توسعه‌دهنده استفاده می‌کند (نسخه بتا) را ببینید.
در بخش «کاتالوگ API»، یک یا چند API را انتخاب کنید.
«میاناهای برنامه‌سازی کاربردی» در کاتالوگ به «میاناهای برنامه‌سازی کاربردی اصالت‌سنجی‌شده» (که به نشانی وب برگشتی نیاز دارند) یا «میاناهای برنامه‌سازی کاربردی عمومی» دسته‌بندی می‌شوند. برای ایجاد برنامه باید حداقل یک API انتخاب کنید.
اگر یک API را در بخش «میاناهای برنامه‌سازی کاربردی اصیل‌سازی‌شده» انتخاب کنید، یک نشانی وب تماس برگشتی وارد کنید.
برای اطلاعات بیشتر، به درباره نشانی‌های وب برگشت تماس مراجعه کنید.
روی ایجاد کردن کلیک کنید.
ثبت برنامه‌های تیم توسعه‌دهنده
اعضای تیم توسعه‌دهنده می‌توانند برنامه‌ها را برای تیم توسعه‌دهنده ثبت کنند تا از میاناهای برنامه‌سازی کاربردی که منتشر کرده‌اید استفاده کنند، همان‌طور که در زیر توضیح داده شده است.
برای کسب اطلاعات بیشتر درباره نحوه:
- کاربران درگاه تیم‌ها را اضافه و مدیریت می‌کنند، همان‌طور که در اشتراک مسئولیت برای برنامه بااستفاده از تیم‌های توسعه‌دهنده (نسخه بتا) توضیح داده شده است.
- ارائه‌دهندگان API تیم‌های توسعه‌دهنده را مشاهده و مدیریت می‌کنند، همان‌طور که در مدیریت تیم‌های توسعه‌دهنده توضیح داده شده است.
برای ثبت برنامه‌های تیم توسعه‌دهنده:
- تیم‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- روی ردیف تیم توسعه‌دهنده‌ای که می‌خواهید برنامه‌ای را برای آن ثبت کنید کلیک کنید.
- برای ایجاد برنامه جدید، روی + برنامه جدید کلیک کنید.
- در کادر گفتگوی «برنامه جدید»، نام و شرحی برای برنامه وارد کنید.
مالک برنامه را در فهرست کرکره‌ای مالک انتخاب کنید.
به‌طور پیش‌فرض، تیم توسعه‌دهنده مالک برنامه است. درصورت تمایل، تیم توسعه‌دهنده دیگری یا خودتان را به‌عنوان مالک از منو کرکره‌ای انتخاب کنید.
در بخش «کاتالوگ API»، یک یا چند API را انتخاب کنید.
«میاناهای برنامه‌سازی کاربردی» در کاتالوگ به «میاناهای برنامه‌سازی کاربردی اصالت‌سنجی‌شده» (که به نشانی وب برگشتی نیاز دارند) یا «میاناهای برنامه‌سازی کاربردی عمومی» دسته‌بندی می‌شوند. برای ایجاد برنامه باید حداقل یک API انتخاب کنید.
اگر یک API را در بخش «میاناهای برنامه‌سازی کاربردی اصیل‌سازی‌شده» انتخاب کنید، یک نشانی وب تماس برگشتی وارد کنید.
برای اطلاعات بیشتر، به درباره نشانی‌های وب برگشت تماس مراجعه کنید.
روی ایجاد کردن کلیک کنید.
مدیریت کردن میاناهای برنامه‌سازی کاربردی در برنامه
به‌عنوان تولیدکننده API، شما APIها را منتشر می‌کنید تا کاربران درگاه بتوانند از محصولات API شما استفاده کنند.
کاربران درگاه مدیریت می‌کنند که برنامه‌هایشان از کدام میاناهای برنامه‌سازی کاربردی استفاده کنند. «میاناهای برنامه‌سازی کاربردی» به صفحه جزئیات برنامه اضافه می‌شود. برای برخی‌از APIها، تأیید خودکار نیست. وضعیت درانتظار تأیید نشان‌دهنده میانای برنامه‌سازی کاربردی است که دسترسی به آن درخواست شده است اما هنوز اعطا نشده است.
کاربران درگاه می‌توانند میاناهای برنامه‌سازی کاربردی را در یک برنامه از درگاه شما به روش‌های زیر مدیریت کنند:
- برنامه‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- روی برنامه در فهرست کلیک کنید.
- در بخش «میاناهای برنامه‌سازی کاربردی»، روی
یا 
کلیک کنید تا دسترسی به میانای برنامه‌سازی کاربردی از برنامه را به‌ترتیب فعال یا غیرفعال کنید. - برای «میانای برنامه‌سازی کاربردی اصالت‌سنجی‌شده»، نشانی وب تماس برگشتی را درصورت نیاز اضافه یا ویرایش کنید.
مشاهده کلید میانای برنامه‌سازی کاربردی و رمز برنامه
کاربران درگاه می‌توانند کلید API را برای یک برنامه از درگاه شما به این صورت مدیریت کنند:
- برنامه‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- روی برنامه در فهرست کلیک کنید.
- کلیدهای میانای برنامه‌سازی کاربردی را در بخش «کلیدهای میانای برنامه‌سازی کاربردی» مشاهده کنید.
- تأیید کنید که وضعیت کلید API روی «فعال» تنظیم شده باشد. اگر کلید API شما نیاز به تأیید داشته باشد و هنوز تأیید نشده باشد، وضعیت آن به‌عنوان درانتظار تأیید نمایش داده خواهد شد.
- برای مشاهده رمز، روی نمایش رمز کلیک کنید.
- مکان‌نما را روی کلید API یا رمز قرار دهید و روی
کلیک کنید تا آن را در کلیپ‌بورد کپی کنید.
چرخاندن کلید میانای برنامه‌سازی کاربردی برای برنامه
کاربر پورتال می‌تواند کلید API برنامه را به‌صورت دوره‌ای یا در پاسخ به نشت یا به‌خطر افتادن احتمالی آن بچرخاند. وقتی کاربر درگاهی کلید API را می‌چرخاند، کلید API جدیدی با همان حقوق API کلید اصلی ایجاد می‌شود. کلید API اصلی درحالی‌که آن را از استفاده خارج می‌کنید، فعال باقی می‌ماند. باید کلید API قدیمی را باطل کنید تا از پذیرفته شدن اطلاعات اعتباری آن جلوگیری شود، همان‌طور که در باطل کردن کلید API برای برنامه توضیح داده شده است.
کاربران درگاه می‌توانند کلید API را برای یک برنامه از درگاه شما به‌صورت زیر بچرخانند:
- برنامه‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- روی برنامه در فهرست کلیک کنید.
- در بخش «کلیدهای API»، روی افزودن کلید کلیک کنید.
- برای تأیید عملیات، در چارگوش گفتگو روی تأیید کلیک کنید.
- به‌صورت اختیاری، کلید میانای API قدیمی را همان‌طور که در زیر توضیح داده شده است باطل کنید.
لغو کردن کلید میانای برنامه‌سازی کاربردی برای یک برنامه
وقتی کاربر درگاه کلید API را می‌چرخاند، همان‌طور که در بخش قبلی توضیح داده شد، کلید API درحالی‌که آن را از استفاده خارج می‌کنید فعال باقی می‌ماند. برای جلوگیری از پذیرفته شدن اطلاعات اعتباری کلید API، باید آن را فسخ کنید.
کاربران درگاه می‌توانند کلید API برنامه‌ای را از درگاه شما به‌صورت زیر باطل کنند:
- برنامه‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- روی نام برنامه کلیک کنید.
- در بخش «کلیدهای API»، روی در ستون «کنش‌ها» مربوط به کلید API که می‌خواهید باطل کنید کلیک کنید.
برای تأیید عملیات، روی تأیید کلیک کنید.
«وضعیت» کلید به «باطل‌شده» به‌روزرسانی می‌شود.
ویرایش جزئیات برنامه
کاربران درگاه می‌توانند جزئیات برنامه را به‌صورت زیر ویرایش کنند:
- برنامه‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- روی برنامه در فهرست کلیک کنید.
- فیلدهای «نام» یا «شرح» را در برگه «جزئیات برنامه» ویرایش کنید.
- درصورت نیاز، میاناهای برنامه‌سازی کاربردی را در برنامه مدیریت کنید.
- روی ذخیره کلیک کنید.
حذف برنامه
کاربران درگاه می‌توانند برنامه را از درگاه شما حذف کنند، به این صورت:
- برنامه‌ها را از منو کرکره‌ای حساب کاربری انتخاب کنید.
- روی برنامه در فهرست کلیک کنید.
- روی حذف کلیک کنید.
- برای تأیید عملیات، روی تأیید کلیک کنید.
برنامه حذف می‌شود و از «فهرست برنامه‌ها» برداشته می‌شود.