شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
یک سازمان، بالاترین سطح کانتینر در Apigee Edge است. این کانتینر شامل تمام پروکسیهای API و منابع مرتبط شما میشود. در حالی که بقیه این مبحث به طور عمیقتری به سازمانها میپردازد، در اینجا چند نکته کاربردی ارائه شده است:
- به طور پیشفرض، نام سازمان شما در URL مورد استفاده برای فراخوانی پروکسیهای API شما، همانطور که در بخش «درباره میزبانهای مجازی» توضیح داده شده است، وجود دارد. برای مثال:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- نام سازمان شما در URL رابط کاربری مدیریت Edge قرار دارد. برای مثال، URL زیر پروکسیهای API را برای سازمان
docsنمایش میدهد:
- اگرچه ممکن است فقط یک سازمان ایجاد کرده باشید، اما میتوانید به عنوان کاربر یا مدیر با مجوزهای خاص به سازمانهای دیگر تعلق داشته باشید. در رابط کاربری مدیریت Edge، اگر به بیش از یک سازمان تعلق دارید، میتوانید همانطور که در «جابجایی بین سازمانهایتان» توضیح داده شده است، به سازمان دیگری تغییر دهید.
- وقتی به عنوان کاربری با نقش مدیر سازمان (Organization Administrator) با API مدیریت تماس برقرار میکنید، در بیشتر تماسها، سازمان (Organization) بخش ضروری مسیر است. برای مثال، درخواست 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ها، محصولات 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 است که یا آزمایشی است یا تولیدی.
برای مثال:
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 بسازید. یک مدیر میتواند شما را به یک سازمان موجود اضافه کند. همه کاربران میتوانند از طریق آدرس https://enterprise.apigee.com وارد Apigee Edge شوند. |
پروکسی API | کاربران یک سازمان یک یا چند پروکسی API ایجاد میکنند. یک پروکسی API، نگاشت یک نقطه پایانی HTTP در دسترس عموم را به یک سرویس backend تعریف میکند. پروکسیهای API همچنین میتوانند طوری پیکربندی شوند که شامل امنیت (مانند OAuth)، انجام تبدیل پیام (مانند XML به JSON)، محدود کردن ترافیک به سرویسهای backend و انجام سایر عملیات ارزشمند روی درخواست، پاسخ و فراخوانیهای سرویس باشند. Edge دادهها را برای تجزیه و تحلیل روی پروکسیهای API جمعآوری میکند. |
محصول API | کاربران یک سازمان یک یا چند محصول API ایجاد میکنند، که در آن یک محصول API مجموعهای از پروکسیهای API است که با یک طرح سرویس ترکیب شدهاند. این طرح سرویس میتواند محدودیتهای دسترسی را برای پروکسیهای API تعیین کند، امنیت را فراهم کند، امکان نظارت و تجزیه و تحلیل را فراهم کند و ویژگیهای اضافی را ارائه دهد. اج دادهها را برای تجزیه و تحلیل محصولات API جمعآوری میکند. |
توسعهدهنده | یک سازمان شامل یک یا چند توسعهدهنده است که برنامههایی را میسازند که از APIهای تعریفشده توسط سازمان شما (که در محصولات API مونتاژ شدهاند) استفاده میکنند. توسعهدهندگان از APIها استفاده میکنند اما نمیتوانند API ایجاد کنند یا هیچ اقدام دیگری در سازمان انجام دهند. توسعهدهندگان میتوانند از داخل شرکت شما باشند، میتوانند شریک باشند، یا میتوانند توسعهدهندگان خارجی باشند که برای دسترسی به APIهای شما هزینه پرداخت میکنند. توسعهدهندگان قبل از اینکه بتوانند یک برنامه را ثبت کنند و یک کلید API برای دسترسی به APIهای شما دریافت کنند، باید در سازمان شما ثبتنام کرده باشند. به عنوان یک ارائهدهنده API، تعیین نحوه اضافه کردن، بهروزرسانی یا حذف توسعهدهندگان در سازمان شما به عهده شماست. میتوانید آنها را به صورت دستی از طریق رابط کاربری مدیریت Edge اضافه کنید، یک پورتال توسعهدهنده ایجاد کنید تا آنها را از طریق یک وبسایت ثبت کنید، یا با استفاده از API مدیریت Edge، مکانیزم ثبتنام خود را تعریف کنید. یک توسعهدهنده نیازی به داشتن حساب کاربری در Edge ندارد و اکثر توسعهدهندگان نیازی به دانستن چیزی در مورد Edge ندارند. اگر توسعهدهنده در Edge حساب کاربری داشته باشد، معمولاً به عنوان کاربر در یک سازمان دیگر یا برای استفاده از خدمات API Edge است. |
برنامه | توسعهدهندگان یک یا چند برنامهی کلاینت ایجاد میکنند که از APIهای شما استفاده میکنند. توسعهدهندگان باید برنامههای خود را در سازمان شما ثبت کنند. یک برنامه در Edge نمایشی از برنامه واقعی یک توسعهدهنده است که یک کلید 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 را فراهم میکند. به عنوان مثال، دادههای key-value-map (KVM) میتوانند در سطح سازمان در دسترس قرار گیرند، به این معنی که API Proxies که در هر محیطی مستقر میشوند، دادههای مشابهی را از KVM دریافت میکنند. برخی از قابلیتها، مانند ذخیرهسازی، میتوانند به سازمان یا به یک محیط خاص در داخل سازمان محدود شوند. دادههای تحلیلی Apigee با ترکیبی از سازمان و محیط تقسیمبندی میشوند.
در زیر، نهادهای اصلی که شما در یک سازمان مدیریت میکنید، از جمله آنهایی که به صورت سراسری در سازمان تعریف شدهاند و آنهایی که به طور خاص برای یک محیط تعریف شدهاند، نشان داده شده است:
