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

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

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

Apigee اطلاعات زیادی در مورد API ها و بهترین شیوه ها برای توسعه و مصرف آنها ارائه می دهد. برای شروع، به پخش وب طراحی API مراجعه کنید یا طراحی رایگان eBook Web API: The Missing Link Best Practices for Crafting Interfaces که توسعه دهندگان دوست دارند را دانلود کنید.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

نسخه رابط API رو به توسعه دهنده.

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

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