شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
یک سازمان ظرف سطح بالا در Apigee Edge است. این شامل تمام پراکسی های API شما و منابع مرتبط است. در حالی که بقیه این موضوع به عمق بیشتری در مورد سازمان ها می پردازد، در اینجا چند نکته کاربردی وجود دارد:
- به‌طور پیش‌فرض، نام سازمان شما در نشانی اینترنتی مورد استفاده برای فراخوانی پراکسی‌های API است، همانطور که در درباره میزبان‌های مجازی توضیح داده شده است. به عنوان مثال:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- نام سازمان شما در URL رابط کاربری مدیریت Edge است. به عنوان مثال، URL زیر پروکسی های API را برای سازمان
docsنمایش می دهد:
- در حالی که ممکن است فقط یک سازمان ایجاد کرده باشید، می توانید به عنوان کاربر یا مدیر با مجوزهای خاص به سازمان های دیگر تعلق داشته باشید. در رابط کاربری Edge management، اگر به بیش از یک سازمان تعلق دارید، می‌توانید به سازمان دیگری بروید همانطور که در جابجایی بین سازمان‌های خود توضیح داده شده است.
- هنگامی که با API مدیریت به عنوان کاربر در نقش مدیر سازمان تماس برقرار می کنید، سازمان بخشی ضروری از مسیر در اکثر تماس ها است. برای مثال، درخواست مدیریت API cURL فهرستی از تمام پراکسی‌های 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ها، محصولات API، برنامه‌ها و توسعه‌دهندگان برنامه‌ها را در Edge مشخص می‌کند.
این مدل تمام ویژگی های Apigee Edge را نشان نمی دهد. اگر از کسب درآمد استفاده می کنید، مدل دارای اجزای اضافی است. برای اطلاعات بیشتر، به نمای کلی کسب درآمد مراجعه کنید. برای کسب اطلاعات در مورد مدیریت شرکت ها و توسعه دهندگان با کسب درآمد به مدیریت شرکت ها و توسعه دهندگان مراجعه کنید.
نام سازمان ها
نام سازمان:
- سازمان ارزیابی:
username-eval - سازمان پولی: در زمان تهیه اولیه توسط کاربر تعریف شده است
پس از ایجاد، نمی توانید نام یک سازمان را تغییر دهید.
نام سازمان بخشی از URL پراکسی های API شما و بخشی از URL در هنگام درخواست به API مدیریت Edge می شود. به عنوان مثال، یک URL معمولی که برای دسترسی به یک پروکسی API استفاده می شود، دارای شکل زیر است:
http://org-name-env.apigee.net/v1/weather/forecastrss
کجا:
- org-name نام سازمان شما است.
- env محیط استقرار پروکسی API است که تست یا prod است.
به عنوان مثال:
http://myorg-test.apigee.net/v1/weather/forecastrss
اجزای سازمان
جدول زیر اجزای مدل سازمانی را با جزئیات بیشتری تشریح می کند:
| جزء | توضیحات |
|---|---|
سازمان | هر حساب Apigee به یک یا چند سازمان در Apigee Edge نقشه می‌گیرد. این سازمان شامل نمایشی از تمام اجزا از جمله پروکسی های API، محصولات API، بسته های API، برنامه ها و توسعه دهندگان است. دارندگان حساب به یک سازمان محدود نمی شوند. برخی از دارندگان حساب ممکن است چندین سازمان را تعریف کنند یا عضوی از چندین سازمان باشند که از جوامع توسعه‌دهنده برنامه‌های مختلف پشتیبانی می‌کنند. |
| محیط زیست | زمینه اجرای زمان اجرا برای پراکسی های API در یک سازمان. برای اطلاعات بیشتر در مورد محیط ها به بخش زیر مراجعه کنید. |
کاربر | در یک سازمان، جایی که شخصی که حساب را ایجاد می کند، به طور خودکار یک سرپرست است، می توانید کاربران بیشتری ایجاد کنید. کاربران تیم API سازمان را تشکیل می‌دهند که می‌تواند شامل افرادی مانند سرپرستان، پروکسی‌های API و سازندگان محصولات API، کاربرانی که بر تجزیه و تحلیل‌ها و آمارهای دیگر نظارت می‌کنند و سایر آمارها باشد. کاربران مختلف می توانند نقش ها و امتیازات دسترسی متفاوتی داشته باشند. به عنوان مثال، برخی از کاربران را به عنوان مدیران سازمان و مدیران عملیات با امتیازاتی برای اصلاح سازمان و اجزای آن تعریف کنید. سایر کاربران را با مجوز ایجاد پروکسی های API و محصولات API تعریف کنید، اما بدون امتیاز تغییر سایر کاربران. کاربران می توانند اعضای چندین سازمان باشند. به عنوان مثال، شرکت شما ممکن است چندین سازمان را در Apigee Edge برای پشتیبانی از جوامع توسعه‌دهنده مختلف تعریف کند. اما در داخل، همان افراد تمام پروکسی‌های API و محصولات API را می‌سازند و بنابراین اعضای همه سازمان‌های شما هستند. برای اینکه کاربر باشید نیازی نیست یک حساب Apigee ایجاد کنید - یعنی یک سازمان Apigee ایجاد کنید. یک مدیر می تواند شما را به یک سازمان موجود اضافه کند. همه کاربران از اینجا وارد Apigee Edge می شوند: https://enterprise.apigee.com . |
پروکسی API | کاربران در یک سازمان یک یا چند پروکسی API ایجاد می کنند. یک پراکسی API نگاشت یک نقطه پایانی HTTP در دسترس عموم را به یک سرویس باطن تعریف می کند. پراکسی‌های API همچنین می‌توانند به گونه‌ای پیکربندی شوند که شامل امنیت (مانند OAuth)، تبدیل پیام (مانند XML به JSON)، محدود کردن ترافیک به سرویس‌های پشتیبان، و انجام سایر عملیات ارزشمند روی درخواست، پاسخ، و فراخوان‌های سرویس شوند. Edge داده ها را برای تجزیه و تحلیل در پروکسی های API جمع آوری می کند. |
محصول API | کاربران در یک سازمان یک یا چند محصول API ایجاد می‌کنند که در آن یک محصول API مجموعه‌ای از پراکسی‌های API است که با یک طرح خدمات ترکیب شده است. این طرح خدمات می‌تواند محدودیت‌های دسترسی را برای پراکسی‌های API تعیین کند، امنیت را فراهم کند، امکان نظارت و تجزیه و تحلیل را فراهم کند و ویژگی‌های اضافی را ارائه دهد. Edge داده ها را برای تجزیه و تحلیل محصولات API جمع آوری می کند. |
توسعه دهنده | یک سازمان شامل یک یا چند توسعه‌دهنده است که برنامه‌هایی را می‌سازند که از API (مجموعه شده در محصولات API) تعریف شده توسط سازمان شما استفاده می‌کنند. توسعه‌دهندگان API را مصرف می‌کنند اما نمی‌توانند API ایجاد کنند یا هیچ اقدام دیگری در سازمان انجام دهند. توسعه دهندگان می توانند داخلی شرکت شما باشند، می توانند شریک باشند، یا می توانند توسعه دهندگان خارجی باشند که برای دسترسی به API های شما هزینه می کنند. توسعه‌دهندگان قبل از اینکه بتوانند یک برنامه را ثبت کنند و یک کلید API برای دسترسی به APIهای شما دریافت کنند، باید در سازمان شما ثبت نام کرده باشند. به‌عنوان یک ارائه‌دهنده API، تعیین نحوه افزودن، به‌روزرسانی یا حذف توسعه‌دهندگان در سازمانتان به عهده شماست. می‌توانید آنها را به‌صورت دستی از طریق رابط کاربری مدیریت Edge اضافه کنید، یک پورتال توسعه‌دهنده ایجاد کنید تا آنها را از طریق یک وب‌سایت ثبت کنید، یا مکانیسم ثبت‌نام خود را با استفاده از API مدیریت Edge تعریف کنید. یک برنامه نویس نیازی به داشتن حساب کاربری در Edge ندارد و اکثر توسعه دهندگان نیازی به دانستن چیزی در مورد Edge ندارند. اگر توسعه‌دهنده یک حساب در Edge داشته باشد، معمولاً به عنوان کاربر در سازمان دیگری یا برای استفاده از خدمات Edge API است. |
برنامه | توسعه دهندگان یک یا چند برنامه مشتری ایجاد می کنند که API های شما را مصرف می کنند. توسعه دهندگان باید برنامه های خود را در سازمان شما ثبت کنند. یک برنامه در لبه نمایشی از برنامه واقعی یک برنامه‌نویس است که کلید API را در اختیار توسعه‌دهنده قرار می‌دهد تا با هر درخواستی به APIهای شما ارسال کند. از آنجایی که همه برنامه‌ها در سازمان شما ثبت شده‌اند، می‌توانید از Edge برای نظارت و جمع‌آوری اطلاعات تحلیلی روی برنامه و استفاده آن از APIهایتان استفاده کنید. |
کلید API/توکن OAuth | بسته به مکانیزم مجوزی که برای API های خود تعریف می کنید، برنامه یک کلید API را همراه با هر درخواست به API های شما ارسال می کند. اگر آن کلید معتبر باشد، درخواست مجاز است. Edge از انواع مختلف احراز هویت مانند یک کلید API ساده، OAuth دو پایه، OAuth سه پایه و موارد دیگر پشتیبانی می کند. به عنوان یک ارائه دهنده API، باید راهی برای توسعه دهندگان تعریف کنید تا برنامه های خود را ثبت کنند. با ثبت برنامه آنها است که کلید مورد نیاز برای دسترسی به API های خود را به توسعه دهنده باز می گردانید. در زمان ثبت برنامه، توسعه دهنده می تواند انتخاب کند که به یک محصول API واحد یا چندین محصول API دسترسی داشته باشد. برنامه واقعی توسعه دهنده از کلید یکسانی برای دسترسی به تمام محصولات API مرتبط با برنامه (نمایندگی ثبت شده برنامه توسعه دهنده در Edge) استفاده می کند. در هر زمان، می‌توانید کلید را لغو کنید تا برنامه توسعه‌دهنده دیگر به APIهای شما دسترسی نداشته باشد (حتی اگر نمایندگی ثبت‌شده برنامه توسعه‌دهنده هنوز در سازمان شما وجود دارد). یا می‌توانید برای یک کلید محدودیت زمانی تعیین کنید تا توسعه‌دهنده باید کلید را پس از یک زمان خاص تازه‌سازی کند. |
درباره محیط ها
یک محیط یک زمینه اجرای زمان اجرا برای پراکسی های API در یک سازمان است. شما باید یک پروکسی API را برای دسترسی به یک محیط به آن مستقر کنید. می توانید یک پراکسی API را در یک محیط واحد یا در چندین محیط مستقر کنید.
یک سازمان می تواند شامل چندین محیط باشد. به عنوان مثال، ممکن است یک محیط dev ، test و prod را در یک سازمان تعریف کنید.
سازمان زمینه را برای برخی از قابلیت های Apigee فراهم می کند. برای مثال، داده‌های نقشه کلید ارزش (KVM) را می‌توان در سطح سازمان در دسترس قرار داد، به این معنی که پراکسی‌های API مستقر در هر محیطی همان داده‌ها را از KVM دریافت می‌کنند. برخی از قابلیت‌ها، مانند حافظه پنهان، می‌توانند به سازمان یا یک محیط خاص در سازمان تعلق داشته باشند. داده های تجزیه و تحلیل Apigee با ترکیبی از سازمان و محیط تقسیم می شود.
در زیر، موجودیت‌های اصلی که در یک سازمان مدیریت می‌کنید، از جمله آن‌هایی که در سطح جهانی در سازمان تعریف شده‌اند، و آن‌هایی که به‌طور خاص برای یک محیط تعریف شده‌اند، نشان داده شده‌اند:
