انجمن‌ها

API چیست؟

API ها مکانیسم هایی هستند که دو جزء نرم افزار را قادر می سازند تا با استفاده از مجموعه ای از تعاریف و پروتکل ها با یکدیگر ارتباط برقرار کنند. به عنوان مثال، سیستم نرم افزاری در Climate Office حاوی داده های آب و هوای روزانه است. برنامه کاربردی آب و هوا در تلفن شما از طریق API با این سیستم "ارتباط" برقرار می کند و  اطلاعات آب و هوای روزانه را در تلفن شما بروز می کند و نمایش می دهد.

API مخفف چیست؟

API مخفف Application Programming Interface  (رابط برنامه نویسی سیستمهای کاربردی) است. در این تعریف، عبارت "سیستمهای کاربردی" (Application) به هر نرم افزاری با عملکرد متمایز اشاره دارد.  "رابط" (Interface) را می توان به عنوان یک قرارداد تبادل خدمات بین دو برنامه در نظر گرفت. این قرارداد نحوه ارتباط این دو برنامه با یکدیگر را با استفاده از درخواست ها (Requests) و پاسخ ها (Responses) تعریف می کند. مستندات API شامل اطلاعاتی درباره نحوه طراحی این درخواست‌ها و پاسخ‌ها توسط توسعه‌دهندگان است.

API ها چگونه کار می کنند؟

ساختار API به شکل کلاینت / سروری است. برنامه ای که درخواست را ارسال می کند به عنوان کلاینت و برنامه ای که پاسخ را ارسال می کند به عنوان سرور شناخته می شود. بنابراین در مثال آب و هوای بالا، سرور، پایگاه داده آب و هوا است و کلاینت، اپلیکیشن موبایل است. 

بسته به قدمت و دلیل ایجاد آنها، چهار روش کار برای  APIها وجود دارد:

API های SOAP 

این APIها از پروتکل دسترسی ساده به اشیا  (Simple Object Access Protocol) استفاده می کنند. در این استاندارد، سرویس گیرنده (کلاینت) و سرور با استفاده از XML پیام ها را مبادله می کنند. این استاندارد که در گذشته بیشتر رایج بوده است، انعطاف پذیری کمتری نسبت به سایر API ها دارد.

API های RPC

این APIها به عنوان فراخوانی از راه دور (Remote Procedure Call) شناخته می شوند. در این روش، کلاینت، یک تابع (یا یک روال برنامه) را در سرور اجرا می کند، و در مرحله بعد، سرور، خروجی را برای مشتری ارسال می کند.

API های Websocket

Websocket API مدل توسعه یافته دیگری از وب APIهای مدرن است که از اشیاء JSON برای ارسال داده استفاده می کند. WebSocket API از ارتباط دو طرفه بین برنامه های کاربردی سرویس گیرنده (کلاینتها) و سرور پشتیبانی می کند.در این روش، سرور می‌تواند پیام‌های برگشتی (Callback) را به مشتریان ارسال کند که از این جهت، کارآمدتر از REST API است.

REST APIها

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

REST API چیست؟

REST مخفف Representational State Transfer است. REST مجموعه ای از توابع مانند GET، PUT، DELETE و غیره را تعریف می کند که مشتریان می توانند از آنها برای دسترسی به داده های سرور استفاده کنند. کلاینت ها و سرورها با استفاده از پروتکل HTTP داده ها را مبادله می کنند.

مزیت اصلی REST API این است که مستقل از وضعیت (Stateless) است، به این معنی که سرورها داده های مشتری را در فواصل زمانی بین درخواست ها ذخیره نمی کنند. درخواست‌های مشتری که به سرور ارسال می‌شوند مشابه URL‌هایی هستند که برای بازدید از یک وب‌سایت در مرورگر خود تایپ می‌کنید. در این استاندارد، پاسخ سرور، به شکل متن ساده و متفاوت با نمایش گرافیکی معمول در صفحات وب است.

وب API چیست؟

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

وجود اصطلاحات مختلف و متعدد مربوط به APIها مانند Java API یا Services API بخاطر این  است که از نظر تاریخی APIها قبل از شبکه جهانی وب ایجاد شده اند. APIهای مدرن وب، APIهای REST هستند که این دو  اصطلاح را می توان به جای هم استفاده کرد.

API همگام ساز چیست؟

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

مزایای REST API چیست؟

API های REST چهار مزیت اصلی را ارائه می دهند:

1. یکپارچه سازی 

API ها برای همگام سازی برنامه های کاربردی جدید با سیستم های نرم افزاری موجود استفاده می شوند. این امکان، روند توسعه را سرعت می بخشد زیرا لازم نیست هر تابع دوباره نوشته شود. می توانید از API ها برای استفاده از کدهای موجود استفاده کنید.

2. نوآوری 

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

3. گسترش

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

4. تعمیر و نگهداری آسان

یک API به عنوان یک دروازه بین دو سیستم عمل می کند. به همین دلیل، هر سیستم متعهد است تغییرات داخلی خود را به نحوی اعمال کند که  API تحت تأثیر قرار نگیرد. بنابراین، هرگونه تغییراتی که یک طرف بعدها در کد ایجاد می کند، طرف دیگر را تحت تاثیر قرار نخواهد داد.

انواع مختلف API چیست؟

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

API های خصوصی

این رابط‌ها برای هر سازمانی داخلی هستند و فقط برای ارتباط سیستم‌ها و داده‌ها در داخل شرکت استفاده می‌شوند.

API های عمومی 

این رابط ها برای عموم در دسترس و باز هستند و ممکن است توسط هر کسی استفاده شود. این نوع رابط ممکن است به تاییدیه ها و هزینه هایی نیاز داشته باشد یا ممکن است به آنها نیاز نداشته باشد.

API های شریک 

توسعه دهندگان شخص ثالث مجاز می توانند به این رابط ها برای کمک به مشارکت B2B دسترسی داشته باشند.

API های ترکیبی 

این رابط ها دو یا چند API مختلف را برای برآوردن نیازها یا رفتارهای سیستم های پیچیده ترکیب می کنند. 

نقطه پایانی  (API endpoint) چیست و چرا مهم است؟

نقاط پایانی API آخرین نقاط اتصال در سیستم ارتباطی API هستند. آنها شامل URL های سرور، سرویس ها و سایر نقاط دیجیتال خاصی هستند که از آنها، اطلاعات بین سیستم ها ارسال و دریافت می شود. نقاط پایانی API به دو دلیل اصلی برای مشاغل مهم هستند: 

1. امنیت

نقاط پایانی API سیستم را در برابر حملات آسیب پذیر می کند. نظارت بر API برای جلوگیری از سوء استفاده های احتمالی مهم است.

2. عملکرد

نقاط پایانی API، به‌ویژه در رابط‌های با ترافیک بالا، می‌توانند گلوگاه‌ها و عملکرد سیستم را تحت تأثیر قرار دهند.

چگونه می توان یک REST API را ایمن کرد؟

همه APIها باید با نظارت و احراز هویت مناسب ایمن شوند. دو راه اصلی برای ایمن سازی API های REST وجود دارد:

1. کدهای احراز هویت 

این توکن ها برای احراز هویت کاربران برای برقراری تماس API استفاده می شوند. توکن‌های احراز هویت اعتبار و حقوق دسترسی کاربران را برای یک تماس API معین، تأیید می‌کنند. به عنوان مثال، هنگامی که به یک سرور ایمیل وارد می شوید، سرویس گیرنده ایمیل از کدهای احراز هویت برای دسترسی ایمن استفاده می کند.

2. کلیدهای API 

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

چگونه یک API ایجاد کنیم؟

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

1. یک طرح  API آماده کنید  

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

2. یک API ایجاد کنید

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

3. API  را تست کنید

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

4.  API  را مستندسازی کنید

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

5.  API را در بازار ارائه دهید

API Marketplaces یک بازار آنلاین برای کالاهای خرده فروشی مانند آمازون است و برای توسعه دهندگان برای خرید و فروش سایر API ها در دسترس است. ارائه API در این بازار، به شما امکان می دهد از آن درآمد کسب کنید.

تست API چیست؟

استراتژی های تست API مشابه سایر روش های تست نرم افزار است. در اینجا تمرکز اصلی روی بررسی پاسخ های سرور است. تست API شامل موارد زیر است:

• ایجاد چندین درخواست برای تست عملکرد، نقاط پایانی API 
• ایجاد واحدهای تست برای سنجش منطق تجاری و صحت کارکردی
• تست امنیت با شبیه سازی حمله امنیتی به سیستم. 

چگونه اسناد API بنویسیم؟

نوشتن مستندات جامع API بخشی از فرآیند مدیریت API است . اسناد API را می توان به طور خودکار با استفاده از ابزارها ایجاد کرد یا به صورت دستی نوشت. برخی از بهترین شیوه ها عبارتند از:

• نوشتن توضیحات به زبان ساده و خوانا. مستندات تولید شده توسط ابزارها ممکن است مفصل و حاوی توضیحات بیش از حد باشد که نیاز به ویرایش داشته باشند.
• استفاده ااز نمونه کد برای توضیح عملکرد.
• دقیق و به روز نگهداشتن مستندات.
• هدف قرار دادن سبک نوشتاری در سطح مبتدی
• پوشش دادن تمام مشکلاتی که API می تواند برای کاربران حل کند.

چگونه از API استفاده کنیم؟

مراحل پیاده سازی API جدید عبارتند از:

1. یک کلید API دریافت کنید. این را می توان با ایجاد یک حساب تایید شده از طرف ارائه دهنده API انجام داد.
2. یک کلاینت (سرویس گیرنده) HTTP API راه اندازی کنید. این ابزار به شما اجازه می دهد تا با استفاده از کلیدهای API دریافتی به راحتی درخواست های API را طراحی کنید.
3. اگر کلاینت API ندارید، می توانید با مراجعه به مستندات API، سعی کنید خودتان درخواست را طراحی کنید.
4. هنگامی که با استفاده از یک  API جدید احساس راحتی کردید، می توانید شروع به استفاده از آن در کد خود کنید.

کجا می توانم API های جدید پیدا کنم؟

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

برخی از وب سایت های محبوب API عبارتند از:

• Rapid API – بزرگترین بازار جهانی API با بیش از 10000 API و 1 میلیون توسعه دهنده فعال در سایت. RapidAPI به کاربران اجازه می دهد قبل از خرید، API ها را مستقیماً روی پلتفرم آزمایش کنند.
• APIهای عمومی – این پلتفرم APIهای راه دور را به 40 دسته سفارشی دسته بندی می کند که مرور و یافتن موردی که نیازهای شما را برآورده می کند آسان می کند.
• APIForThat و APIList – این وب سایت ها شامل لیستی از بیش از 500 API وب و همچنین اطلاعات دقیق در مورد نحوه استفاده از آنها هستند.    

API Gateway چیست؟

API Gateway یک ابزار مدیریت API است که به طور خاص برای مشتریان سازمانی که از طیف گسترده ای از خدمات back-end استفاده می کنند طراحی شده است. دروازه‌های API معمولاً وظایف رایجی مانند احراز هویت کاربر، آمار و مدیریت نرخ اعمال شده برای همه تماس‌های API را انجام می‌دهند.

Amazon API Gateway یک سرویس کاملاً مدیریت شده است که ساخت، استقرار، نگهداری، نظارت و ایمن کردن API ها را در هر مقیاسی برای توسعه دهندگان آسان می کند. تمام وظایف مربوط به پذیرش و پردازش هزاران تماس API همزمان، مانند مدیریت ترافیک، پشتیبانی CORS، احراز هویت، کنترل دسترسی، throttling، نظارت و مدیریت نسخه API را انجام می دهد.