درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
سازمان ظرف سطح بالا در Apigee Edge است. این بایگانی شامل همه پراکسی‌های API و منابع مرتبط است. در ادامه این موضوع، به سازمان‌ها با جزئیات بیشتری پرداخته می‌شود، اما در اینجا چند نکته عملی آورده شده است:
- به‌طور پیش‌فرض، نام سازمان شما در نشانی وب مورداستفاده برای فراخوانی پراکسی‌های میانای برنامه‌سازی کاربردی شما، همان‌طور که در درباره میزبان‌های مجازی توضیح داده شده است، قرار دارد.
برای مثال:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- نام سازمانتان در نشانی وب واسط کاربر مدیریت Edge قرار دارد. برای مثال، نشانی وب زیر پراکسی‌های API را برای سازمان
docsنمایش می‌دهد:
- اگرچه ممکن است فقط یک سازمان ایجاد کرده باشید، می‌توانید به‌عنوان کاربر یا سرپرست با اجازه‌های خاص به سازمان‌های دیگر تعلق داشته باشید. در واسط کاربر مدیریت Edge، اگر متعلق به بیش‌از یک سازمان باشید، می‌توانید همان‌طور که در جابه‌جایی بین سازمان‌هایتان توضیح داده شده است به سازمان دیگری بروید.
- وقتی به‌عنوان کاربر در نقش «سرپرست سازمان» با «میانای برنامه‌سازی کاربردی مدیریت» تماس می‌گیرید، سازمان بخشی الزامی از مسیر در اکثر تماس‌ها است. برای مثال، درخواست cURL API مدیریت زیر
فهرستی از همه پراکسی‌های API در یک سازمان را برمی‌گرداند:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
ویدیو: ویدیو کوتاهی را تماشا کنید تا با نحوه پشتیبانی سازمان‌ها از معماری چند مستأجری برای مدیریت API آشنا شوید.
عناصر سازمان
وقتی حساب Edge ایجاد می‌کنید، Edge به‌طور خودکار سازمانی برای شما ایجاد می‌کند. پس‌از ایجاد، می‌توانید کاربرانی را به سازمانتان اضافه کنید، پراکسی‌های API و محصولات API ایجاد کنید، و توسعه‌دهندگان و برنامه‌ها را ثبت کنید.
تصویر زیر اجزای اصلی مدل سازمانی Edge را نشان می‌دهد. این مدل تعریف می‌کند که چگونه میاناهای برنامه‌سازی کاربردی، محصولات API، برنامه‌ها، و توسعه‌دهندگان برنامه در Edge با هم مرتبط هستند.
این مدل همه ویژگی‌های Apigee Edge را نشان نمی‌دهد. اگر از درآمدزایی استفاده می‌کنید، مدل دارای اجزای اضافی خواهد بود. برای اطلاعات بیشتر، به نمای کلی درآمدزایی مراجعه کنید. برای کسب اطلاعات درباره مدیریت شرکت‌ها و توسعه‌دهندگان با درآمدزایی، به مدیریت شرکت‌ها و توسعه‌دهندگان مراجعه کنید.
نام‌های سازمان
نام سازمان این است:
- سازمان ارزیابی:
username-eval - سازمان پولی: کاربر در زمان آماده‌سازی اولیه تعریف می‌کند
پس‌از ایجاد، نمی‌توانید نام سازمان را تغییر دهید.
نام سازمان به بخشی از نشانی وب پراکسی‌های API شما و بخشی از نشانی وب هنگام درخواست به Edge management API تبدیل می‌شود. برای مثال، نشانی وب معمولی که برای دسترسی به پراکسی میانای برنامه‌سازی کاربردی استفاده می‌شود، این شکل را دارد:
http://org-name-env.apigee.net/v1/weather/forecastrss
کجا:
- org-name نام سازمان شما است.
- env محیط استقرار پراکسی API است که یا آزمایشی است یا تولید.
برای مثال:
http://myorg-test.apigee.net/v1/weather/forecastrss
عناصر سازمان
جدول زیر اجزای مدل سازمانی را با جزئیات بیشتری شرح می‌دهد:
| مؤلفه | شرح |
|---|---|
|
سازمان |
هر حساب Apigee به یک یا چند سازمان در Apigee Edge نگاشت می‌شود. سازمان شامل نمایشی از همه عناصر، ازجمله پراکسی‌های API، محصولات API، بسته‌های API، برنامه‌ها، و توسعه‌دهندگان است. دارندگان حساب محدود به یک سازمان نیستند. برخی‌از دارندگان حساب ممکن است تعریف کنند یا عضو چندین سازمان باشند که از انجمن‌های مختلف توسعه‌دهندگان برنامه پشتیبانی می‌کنند. |
| محیط زیست | بافت اجرای زمان اجرا برای پراکسی‌های API در یک سازمان. برای اطلاعات بیشتر درباره محیط‌ها، بخش زیر را ببینید. |
|
کاربر |
در سازمانی که فرد ایجادکننده حساب به‌طور خودکار سرپرست است، می‌توانید کاربران بیشتری ایجاد کنید. کاربران تیم میانای برنامه‌سازی کاربردی سازمان را تشکیل می‌دهند، که می‌تواند شامل افرادی مثل سرپرستان، سازندگان محصول میانای برنامه‌سازی کاربردی و پراکسی میانای برنامه‌سازی کاربردی، کاربران پایش‌کننده تجزیه‌وتحلیل‌ها و دیگر آمارها، و هر فرد دیگری باشد. کاربران مختلف می‌توانند نقش‌ها و امتیازات دسترسی متفاوتی داشته باشند. برای مثال، برخی‌از کاربران را به‌عنوان «سرپرستان سازمان» و «سرپرستان عملیات» با امتیازهای اصلاح سازمان و عناصر آن تعریف کنید. کاربران دیگری را با اجازه‌هایی برای ایجاد پراکسی‌های API و محصولات API تعریف کنید، اما بدون امتیازهای لازم برای اصلاح کاربران دیگر. کاربران می‌توانند عضو چندین سازمان باشند. برای مثال، شرکت شما ممکن است چندین سازمان را در Apigee Edge تعریف کند تا از انجمن‌های توسعه‌دهنده مختلف پشتیبانی کند. اما در داخل، همان افراد همه پراکسی‌های API و محصولات API را می‌سازند و بنابراین عضو همه سازمان‌های شما هستند. برای کاربر بودن لازم نیست حساب Apigee ایجاد کنید—یعنی سازمان Apigee ایجاد کنید. سرپرست می‌تواند شما را به سازمان موجود اضافه کند. همه کاربران در اینجا به سیستم Apigee Edge وارد می‌شوند: https://enterprise.apigee.com. |
|
پراکسی میانای برنامه‌سازی کاربردی |
کاربران در یک سازمان یک یا چند پراکسی API ایجاد می‌کنند. کارگزار API نگاشت نقطه پایان HTTP دردسترس عمومی به سرویس زیرینه را تعریف می‌کند. کارگزاران میانای برنامه‌سازی کاربردی همچنین می‌توانند برای افزودن امنیت (مثل OAuth)، انجام تبدیل پیام (مثل XML به JSON)، محدود کردن ترافیک به سرویس‌های زیرینه، و انجام عملیات ارزشمند دیگر روی درخواست، پاسخ، و با فراخوانی‌های سرویس پیکربندی شوند. Edge داده‌هایی را برای تجزیه‌وتحلیل کارگزاران نیابتی API جمع‌آوری می‌کند. |
|
محصول میانای برنامه‌سازی کاربردی |
کاربران در یک سازمان یک یا چند محصول API ایجاد می‌کنند، که در آن محصول API مجموعه‌ای از پراکسی‌های API است که با یک طرح سرویس ترکیب شده است. این طرح خدمات می‌تواند محدودیت‌های دسترسی را برای پراکسی‌های API تنظیم کند، امنیت را فراهم کند، امکان پایش و تجزیه‌وتحلیل را فراهم کند، و ویژگی‌های اضافی ارائه دهد. Edge داده‌ها را برای تجزیه‌وتحلیل محصولات «میانای برنامه‌سازی کاربردی» جمع‌آوری می‌کند. |
|
توسعه‌دهنده |
سازمان شامل یک یا چند توسعه‌دهنده است که برنامه‌هایی را می‌سازند که از میاناهای برنامه‌سازی کاربردی (تجمیع‌شده در محصولات میانای برنامه‌سازی کاربردی) تعریف‌شده توسط سازمان شما استفاده می‌کنند. توسعه‌دهندگان از میاناهای برنامه‌سازی کاربردی استفاده می‌کنند اما نمی‌توانند میانای برنامه‌سازی کاربردی ایجاد کنند یا کنش‌های دیگری در سازمان انجام دهند. توسعه‌دهندگان می‌توانند داخلی شرکت شما، شریک، یا توسعه‌دهندگان خارجی باشند که برای دسترسی به واسط‌های برنامه‌سازی کاربردی شما هزینه پرداخت می‌کنند. توسعه‌دهندگان باید در سازمانتان ثبت شوند تا بتوانند برنامه ثبت کنند و کلید میانای برنامه‌سازی کاربردی برای دسترسی به میاناهای برنامه‌سازی کاربردی شما دریافت کنند. به‌عنوان ارائه‌دهنده API، تعیین نحوه اضافه کردن، به‌روزرسانی، یا برداشتن توسعه‌دهندگان در سازمانتان برعهده شما است. می‌توانید آن‌ها را به‌طور دستی ازطریق واسط کاربر مدیریت Edge اضافه کنید، درگاه توسعه‌دهنده ایجاد کنید تا آن‌ها را ازطریق وب‌سایت ثبت کنید، یا بااستفاده از میانای برنامه‌سازی کاربردی مدیریت Edge، سازوکار ثبت خودتان را تعریف کنید. توسعه‌دهنده ملزم به داشتن حساب در Edge نیست و اکثر توسعه‌دهندگان نیازی به دانستن چیزی درباره Edge ندارند. اگر توسعه‌دهنده در Edge حساب داشته باشد، معمولاً به‌عنوان کاربر در سازمانی دیگر یا برای استفاده از «سرویس‌های Edge API» است. |
|
برنامه |
توسعه‌دهندگان یک یا چند برنامه مشتری ایجاد می‌کنند که از «میاناهای برنامه‌سازی کاربردی» شما استفاده می‌کنند. توسعه‌دهندگان باید برنامه‌هایشان را در سازمان شما ثبت کنند. «برنامه در Edge» نمایشی از برنامه واقعی توسعه‌دهنده است که کلید API را دراختیار توسعه‌دهنده قرار می‌دهد تا با هر درخواست به APIهای شما ارسال کند. ازآنجایی‌که همه برنامه‌ها در سازمانتان ثبت شده‌اند، می‌توانید از Edge برای پایش و جمع‌آوری اطلاعات تحلیلی درباره برنامه و استفاده آن از «میاناهای برنامه‌سازی کاربردی» استفاده کنید. |
|
کلید میانای API/کد OAuth |
بسته به سازوکار اصالت‌سنجی که برای میاناهای برنامه‌سازی کاربردی خود تعریف می‌کنید، برنامه کلید API را همراه با هر درخواست به میاناهای برنامه‌سازی کاربردی شما ارسال می‌کند. اگر آن کلید معتبر باشد، درخواست مجاز است. Edge از انواع مختلف اصالت‌سنجی، مثل کلید API ساده، OAuth دو سر، OAuth سه سر، و غیره پشتیبانی می‌کند. به‌عنوان ارائه‌دهنده API، باید روشی برای توسعه‌دهندگان تعریف کنید تا برنامه‌هایشان را ثبت کنند. با ثبت برنامه است که کلید لازم برای دسترسی به میاناهای برنامه‌سازی کاربردی خود را به توسعه‌دهنده برمی‌گردانید. در زمان ثبت برنامه، توسعه‌دهنده می‌تواند انتخاب کند که به یک محصول API یا چند محصول API دسترسی داشته باشد. برنامه واقعی توسعه‌دهنده از همان کلید برای دسترسی به همه محصولات API مرتبط با برنامه (نمایش ثبت‌شده برنامه توسعه‌دهنده در Edge) استفاده می‌کند. هرزمان بخواهید می‌توانید کلید را باطل کنید تا برنامه توسعه‌دهنده دیگر به میاناهای برنامه‌سازی کاربردی شما دسترسی نداشته باشد (حتی اگر نمای ثبت‌شده برنامه توسعه‌دهنده هنوز در سازمانتان وجود داشته باشد). یا می‌توانید برای کلید محدودیت زمانی تعریف کنید تا توسعه‌دهنده پس‌از مدت زمان مشخصی کلید را بازآوری کند. |
درباره محیط‌ها
محیط یک زمینه اجرای زمان اجرا برای پراکسی‌های API در یک سازمان است. پیش‌از اینکه بتوانید به یک پراکسی API دسترسی پیدا کنید، باید آن را در محیطی مستقر کنید. می‌توانید کارگزار API را در یک محیط یا چند محیط مستقر کنید.
سازمان می‌تواند شامل چندین محیط باشد. برای مثال، ممکن است محیط dev، test، و prod را در سازمانی تعریف کنید.
سازمان برای برخی‌از قابلیت‌های Apigee محدوده ارائه می‌دهد. برای مثال، داده‌های نقشه کلید-مقدار (KVM) را می‌توان در سطح سازمان دردسترس قرار داد، به این معنی که «پراکسی‌های API» که در هر محیطی مستقر شده‌اند داده‌های یکسانی را از KVM دریافت می‌کنند. برخی‌از قابلیت‌ها، مثل حافظه نهان، می‌توانند در سطح سازمان یا در سطح محیطی خاص در سازمان محدود شوند. داده‌های تجزیه‌وتحلیل Apigee براساس ترکیبی از سازمان و محیط تقسیم‌بندی می‌شود.
در زیر، نهادهای اصلی که در یک سازمان مدیریت می‌کنید نشان داده شده است، ازجمله نهادهایی که به‌صورت جهانی در سازمان تعریف شده‌اند و نهادهایی که به‌طور خاص برای یک محیط تعریف شده‌اند:
