اصطلاحات پایه

رابط برنامه‌نویسی کاربردی - رابطی که استفاده از قابلیت‌ها یا داده‌های یک برنامه دیگر را برای یک برنامه آسان می‌کند.

با تعریف نقاط ورود پایدار و ساده به منطق و داده‌های برنامه، APIها به توسعه‌دهندگان این امکان را می‌دهند که به راحتی به منطق برنامه ساخته شده توسط سایر توسعه‌دهندگان دسترسی پیدا کرده و از آن استفاده مجدد کنند. در مورد APIهای وب ، این منطق و داده‌ها از طریق شبکه در دسترس هستند. از آنجایی که برنامه‌هایی که از APIها استفاده می‌کنند به تغییرات حساس هستند، APIها همچنین مستلزم یک قرارداد هستند. این قرارداد تا حدی تضمین می‌کند که API در طول زمان به شیوه‌ای قابل پیش‌بینی تغییر خواهد کرد.

Apigee اطلاعات زیادی در مورد APIها و بهترین شیوه‌ها برای توسعه و استفاده از آنها ارائه می‌دهد. برای شروع، به وبکست طراحی API مراجعه کنید یا کتاب الکترونیکی رایگان طراحی API وب: حلقه گمشده بهترین شیوه‌ها برای ساخت رابط‌هایی که توسعه‌دهندگان دوست دارند را دانلود کنید.

یک نما (facade) در اج برای یک یا چند API، سرویس‌های عمومی HTTP یا برنامه‌ها (مانند Node.js ).

یک پروکسی API به صورت مجموعه‌ای از فایل‌های پیکربندی، سیاست‌ها و کد پیاده‌سازی می‌شود که به مجموعه‌ای از منابع ارائه شده توسط Apigee Edge متکی هستند. پروکسی‌های API را می‌توان با استفاده از رابط کاربری مدیریت Apigee Edge تولید و پیکربندی کرد، یا می‌توان آنها را به صورت محلی در یک ویرایشگر متن یا IDE پیاده‌سازی کرد.

نمای ارائه شده توسط یک پروکسی API، API سمت توسعه‌دهنده را از سرویس‌های backend جدا می‌کند، توسعه‌دهندگان را از تغییرات کد محافظت می‌کند و نوآوری را در لبه بدون تأثیر بر تیم‌های توسعه داخلی شما امکان‌پذیر می‌سازد. همزمان با اعمال تغییرات backend توسط تیم‌های توسعه، توسعه‌دهندگان همچنان بدون وقفه به فراخوانی همان رابط کاربری ادامه می‌دهند. Apigee شما را قادر می‌سازد تا چندین رابط کاربری را در معرض همان API قرار دهید و شما را آزاد می‌کند تا امضای یک API را برای برآورده کردن نیازهای بخش‌های مختلف توسعه‌دهنده به طور همزمان سفارشی کنید.

APIها توسط آدرس‌های شبکه و URIها تعریف می‌شوند. یک API از یک مسیر پایه و مجموعه‌ای از منابع API تشکیل شده است. هر پروکسی API یک مسیر پایه و به صورت اختیاری، چندین مسیر منبع API را تعریف می‌کند. می‌توانید یک API را به سادگی به عنوان مجموعه‌ای از URIها در نظر بگیرید که همه آنها یک مسیر پایه مشترک دارند.

برای آسان‌تر کردن مدیریت APIهای شما، Apigee این URIهای خام را با نام‌های نمایشی و توضیحات تکمیل می‌کند. Edge به شما امکان می‌دهد سیاست‌ها و کدها را به URIها پیوست کنید و کنترل و مدیریت دقیق رفتار APIهای خود را امکان‌پذیر می‌سازد.

مجموعه‌ای از منابع API (URI) همراه با سهمیه یا طرح سرویس که در زمان طراحی برای توسعه‌دهندگان برنامه منتشر می‌شود. محصولات API می‌توانند به نوبه خود برای کسب درآمد در بسته‌های API قرار گیرند.

یک کلید API به یک یا چند محصول API متصل است و اتصالی بین یک برنامه و مجموعه URIهایی که برنامه مجاز به استفاده از آنها است، برقرار می‌کند.

مخفف application است. اصطلاح app به برنامه‌های موبایلی اطلاق می‌شود که از APIها استفاده می‌کنند. توسعه‌دهندگان، برنامه‌ها را با زبان‌های برنامه‌نویسی مختلف و با استفاده از فناوری‌ها و پلتفرم‌های مختلف پیاده‌سازی می‌کنند. توسعه‌دهندگانی که می‌خواهند از APIها استفاده کنند، برنامه‌ها را در سازمان ارائه‌دهنده API در Apigee Edge ثبت می‌کنند.

وقتی برنامه ثبت می‌شود، Apigee یک کلید API و یک رمز ایجاد می‌کند که برنامه را شناسایی می‌کند. توسعه‌دهنده کلید API را در برنامه جاسازی می‌کند که هنگام درخواست‌ها، کلید را ارائه می‌دهد. سرویس‌های API امنیت را در اطراف کلید API از طریق اعتبارسنجی مستقیم کلید API یا از طریق OAuth پیاده‌سازی می‌کنند.

یک زمینه اجرای زمان اجرا برای پروکسی‌های API. یک پروکسی API باید قبل از اینکه API ارائه شده از طریق شبکه قابل دسترسی باشد، در یک محیط مستقر شود. به طور پیش‌فرض، سازمان‌ها با دو محیط تجهیز شده‌اند: test و prod .

• محیط تست معمولاً برای استقرار پروکسی‌های API در طول توسعه استفاده می‌شود.
• محیط تولید معمولاً برای تبلیغ پروکسی‌های API از محیط تست، پس از توسعه و آزمایش کامل آنها، استفاده می‌شود.

یک محفظه برای تمام اشیاء موجود در یک حساب Apigee Edge، شامل پروکسی‌های API، محصولات API، بسته‌های API، برنامه‌ها و توسعه‌دهندگان.

برای هر سازمانی که عضو آن هستید، یک حساب کاربری لازم است. (بیشتر کاربران فقط در یک سازمان حساب کاربری خواهند داشت.)

یک مرحله پردازشی که به عنوان یک واحد منطقی اتمیک و قابل استفاده مجدد در جریان پردازش پروکسی API اجرا می‌شود.

قابلیت‌های معمول مبتنی بر سیاست شامل تبدیل قالب پیام‌ها، اعمال کنترل دسترسی، فراخوانی سرویس‌های راه دور برای اطلاعات بیشتر، پنهان کردن داده‌های حساس از کاربران خارجی، بررسی محتوای پیام برای شناسایی تهدیدات بالقوه، ذخیره پاسخ‌های رایج برای بهبود عملکرد و غیره می‌شود.

سیاست‌ها ممکن است به صورت مشروط بر اساس محتوا یا زمینه یک پیام درخواست یا پاسخ اجرا شوند. به عنوان مثال، اگر پیام درخواست از یک تلفن هوشمند ارسال شده باشد، ممکن است یک سیاست تبدیل برای سفارشی‌سازی قالب پاسخ اجرا شود.

نسخه رابط API که در دسترس توسعه‌دهندگان قرار دارد.

برای مثال، pivotaltracker.com/services/v3 یا api.enterprise.apigee.com/v1 .

این اصطلاح با revision که بسته‌ای شماره‌گذاری شده و کنترل‌شده از پیکربندی و سیاست‌هایی است که در یک API Proxy قرار دارند، متفاوت است. رابط‌های API دارای نسخه هستند؛ API Proxyها دارای نسخه هستند.