درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
درگاه توسعه‌دهنده به‌طور پیش‌فرض به توسعه‌دهندگان برنامه شما امکان می‌دهد برنامه‌هایی را که از میاناهای برنامه‌سازی کاربردی شما استفاده می‌کنند ثبت، به سیستم آن‌ها وارد، و آن‌ها را مدیریت کنند.
بخش‌های زیر نحوه تعامل توسعه‌دهندگان برنامه با درگاه شما را شرح می‌دهد:
نحوه پیگیری ثبت‌نام و ورود به سیستم توسعه‌دهنده برنامه در Edge
ثبت‌نام توسعه‌دهنده و ورود به سیستم درگاه بااستفاده از مشخصه سفارشی _apiportal در Edge ردیابی می‌شود.
وقتی توسعه‌دهنده‌ای خودثبت‌نام می‌کند، مشخصه سفارشی _apiportal به پیکربندی توسعه‌دهنده اضافه می‌شود و وضعیت توسعه‌دهنده روی unverified تنظیم می‌شود تا نشان دهد توسعه‌دهنده به سیستم درگاه وارد نشده است. برای مثال: {"status":"unverified","portals":{}}
اولین‌باری که توسعه‌دهنده به سیستم درگاهی وارد می‌شود، _apiportal مشخصه سفارشی به‌روزرسانی می‌شود تا نام درگاه و زمان دسترسی را پیگیری کند و وضعیت توسعه‌دهنده را روی active تنظیم کند. هر بار که توسعه‌دهنده به پرتال وارد می‌شود، مشخصه سفارشی به‌روز می‌شود تا مقدار lastVisit (در قالب epoch) برای آن پرتال بازنشانی شود. برای مثال: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}
ثبت حساب توسعه‌دهنده برنامه
قبل‌از اینکه توسعه‌دهندگان برنامه بتوانند از میاناهای برنامه‌سازی کاربردی شما استفاده کنند، باید با ایجاد حساب ثبت‌نام کنند.
وقتی توسعه‌دهنده نرم‌افزاری در درگاه شما ثبت‌نام می‌کند:
- اطلاعات توسعه‌دهنده برنامه در Edge ایجاد و ذخیره می‌شود. محل ذخیره اطلاعات حساب توسعه‌دهنده را ببینید.
- توسعه‌دهنده برنامه در فهرست توسعه‌دهندگان برنامه ثبت‌شده ظاهر می‌شود. کاوش صفحه توسعه‌دهندگان را ببینید.
یا می‌توانید توسعه‌دهندگان برنامه را ازطرف آن‌ها بااستفاده از «میانای کاربری Edge» ثبت کنید، همان‌طور که در ثبت توسعه‌دهندگان برنامه توضیح داده شده است.
توسعه‌دهندگان برنامه جدید می‌توانند به‌صورت خودکار در درگاه شما ثبت‌نام کنند:
- به درگاه پیمایش کنید.
- روی ورود به سیستم کلیک کنید.
روی ثبت‌نام کلیک کنید.
کادر گفتگوی زیر نمایش داده می‌شود.
اطلاعات موردنیاز (نام، نام خانوادگی، و نشانی ایمیل) را وارد کنید.
روی ایجاد کردن کلیک کنید.
کادر گفتگوی زیر نمایش داده می‌شود.
برای باز کردن درگاه و ایجاد جلسه اصالت‌سنجی‌شده، روی پیوند امن در ایمیل کلیک کنید.
ورود به سیستم درگاه
پس‌از اینکه توسعه‌دهندگان برنامه در درگاه شما ثبت‌نام کردند، بااستفاده از صفحه «ورود به سیستم» به سیستم وارد می‌شوند.
هر بار که توسعه‌دهنده برنامه به سیستم درگاهی وارد می‌شود، به‌جای استفاده از رمز مشترک مانند گذرواژه برای اصالت‌سنجی توسعه‌دهنده، پیوند امنی برای درستی‌سنجی هویت و ایجاد جلسه با درگاه ارسال می‌شود.
توسعه‌دهندگان نرم‌افزار می‌توانند به سیستم درگاه شما وارد شوند، به این صورت:
- به درگاه پیمایش کنید.
- روی ورود به سیستم کلیک کنید.
- نشانی ایمیل مرتبط با حساب را وارد کنید.
روی ورود به سیستم کلیک کنید.
کادر گفتگوی زیر نمایش داده می‌شود.
برای باز کردن درگاه و ایجاد جلسه اصالت‌سنجی‌شده، روی پیوند امن در ایمیل کلیک کنید.
ثبت برنامه‌ها
پس‌از ورود به سیستم درگاه، توسعه‌دهندگان برنامه می‌توانند برنامه‌ها را برای استفاده از محصولات «میانای برنامه‌سازی کاربردی» که منتشر کرده‌اید ثبت کنند، به این صورت:
- برنامه‌های من را از منو کرکره‌ای کاربر انتخاب کنید.
- برای ایجاد برنامه جدید، روی + برنامه کلیک کنید.
- در کادر گفتگوی «ایجاد برنامه»، نام و شرحی برای برنامه وارد کنید.
- روی ایجاد کردن کلیک کنید.
- محصولات «میانای برنامه‌سازی کاربردی» را در برنامه، همان‌طور که در زیر توضیح داده شده است، مدیریت کنید.
مدیریت محصولات «میانای برنامه‌سازی کاربردی» در برنامه
توسعه‌دهندگان برنامه می‌توانند محصولات «میانای برنامه‌سازی کاربردی» را در برنامه‌هایشان مدیریت کنند. محصولات API به صفحه جزئیات برنامه اضافه می‌شوند. برای برخی محصولات API، تأیید خودکار نیست. وضعیت معلقه نشان‌دهنده محصول API است که دسترسی به آن درخواست شده است اما هنوز اعطا نشده است.
توسعه‌دهندگان نرم‌افزار می‌توانند محصولات میانای برنامه‌سازی کاربردی را در یک برنامه از درگاه شما به این صورت مدیریت کنند:
- برنامه‌های من را از منو کرکره‌ای کاربر انتخاب کنید.
- روی نام برنامه کلیک کنید.
- روی مدیریت محصولات کلیک کنید.
برای فعال یا غیرفعال کردن دسترسی به محصول API از برنامه، روی کلید دسترسی کلیک کنید.
توجه: اگر توسعه‌دهنده برنامه دسترسی به محصول API را که فقط «خصوصی» یا «داخلی» است غیرفعال کند، محصول API از برنامه برداشته می‌شود و سرپرست درگاه باید آن را به‌صورت دستی دوباره اضافه کند، همان‌طور که در ثبت برنامه‌ها و مدیریت کلیدهای API توضیح داده شده است.
برای درخواست تأیید محصول API که هنوز مجاز نیست، روی درخواست کلیک کنید.
روی ذخیره کلیک کنید.
مشاهده کلید میانای برنامه‌سازی کاربردی برای برنامه
توسعه‌دهندگان نرم‌افزار می‌توانند کلید API را برای یک برنامه از پورتال شما به این صورت مدیریت کنند:
- برنامه‌های من را از منو کرکره‌ای کاربر انتخاب کنید.
- روی نام برنامه کلیک کنید.
- کلید API را در بخش کلیدها مشاهده کنید.
- برای نمایش رمز کلید API، روی مشاهده رمز کلیک کنید.
- تأیید کنید که وضعیت کلید API روی «تأییدشده» تنظیم شده باشد.
چرخاندن کلید میانای برنامه‌سازی کاربردی برای برنامه
توسعه‌دهنده برنامه می‌تواند کلید API برنامه را به‌صورت دوره‌ای یا در پاسخ به نشت یا به‌خطر افتادن احتمالی آن بچرخاند. وقتی توسعه‌دهنده برنامه کلید API را می‌چرخاند، کلید API جدیدی با همان حقوق محصول API کلید اصلی ایجاد می‌شود. کلید API اصلی به‌عنوان منسوخ علامت‌گذاری شده است، اما تا زمانی که آن را از استفاده خارج کنید فعال باقی می‌ماند. باید کلید منسوخ‌شده را غیرفعال کنید تا از پذیرفته شدن اطلاعات اعتباری آن جلوگیری شود، همان‌طور که در غیرفعال کردن کلید API برای برنامه توضیح داده شده است.
توسعه‌دهندگان نرم‌افزار می‌توانند کلید API اصلی را برای یک برنامه از پورتال شما به‌صورت زیر بچرخانند:
- برنامه‌های من را از منو کرکره‌ای کاربر انتخاب کنید.
- روی نام برنامه کلیک کنید.
- در بخش «کلیدها»، مکان‌نما را روی کلید API کنونی قرار دهید تا منو کنش‌ها نمایش داده شود.
- برای ازهم بازکردن منو کنش‌ها، روی
کلیک کنید. - روی چرخش کلیک کنید.
- برای تأیید عملیات، روی ایجاد در چارگوش گفتگو کلیک کنید.
- به‌صورت اختیاری، کلید API را غیرفعال کنید، همان‌طور که در زیر توضیح داده شده است.
غیرفعال کردن کلید میانای برنامه‌سازی کاربردی برای یک برنامه
وقتی توسعه‌دهنده برنامه کلید API را می‌چرخاند، همان‌طور که در بخش قبلی توضیح داده شد، کلید API به‌عنوان منسوخ علامت‌گذاری می‌شود، اما درحالی‌که آن را از استفاده خارج می‌کنید، فعال باقی می‌ماند. برای جلوگیری از پذیرفته شدن اطلاعات اعتباری کلید منسوخ‌شده، باید آن را غیرفعال کنید.
توسعه‌دهندگان نرم‌افزار می‌توانند کلید API را برای یک برنامه از درگاه شما غیرفعال کنند، به این صورت:
- برنامه‌های من را از منو کرکره‌ای کاربر انتخاب کنید.
- روی نام برنامه کلیک کنید.
- در بخش «کلیدها»، روی سابقه کلیدها کلیک کنید تا فهرست کلیدهای منسوخ‌شده نمایش داده شود.
- مکان‌نما را روی کلید منسوخ‌شده میانای برنامه‌سازی کاربردی که می‌خواهید غیرفعال کنید قرار دهید تا منو کنش‌ها نمایش داده شود.
- برای ازهم بازکردن منو کنش‌ها، روی کلیک کنید.
- روی غیرفعال کردن کلیک کنید.
- برای تأیید عملیات، روی غیرفعال کردن کلیک کنید.
«وضعیت» کلید به «لغو‌شده» به‌روزرسانی می‌شود.
ویرایش جزئیات برنامه
توسعه‌دهندگان برنامه می‌توانند جزئیات برنامه را به‌صورت زیر ویرایش کنند:
- برنامه‌های من را از منو کرکره‌ای کاربر انتخاب کنید.
- روی نام برنامه کلیک کنید.
- فیلدهای «نام» یا «شرح» را ویرایش کنید.
- روی ذخیره کلیک کنید.
برنامه حذف می‌شود و از فهرست «برنامه‌های من» برداشته می‌شود.
حذف برنامه
توسعه‌دهندگان نرم‌افزار می‌توانند برنامه را از درگاه شما حذف کنند، به این صورت:
- برنامه‌های من را از منو کرکره‌ای کاربر انتخاب کنید.
- روی نام برنامه کلیک کنید.
- روی حذف در گوشه بالای صفحه کلیک کنید.
برنامه حذف می‌شود و از فهرست «برنامه‌های من» برداشته می‌شود.