نحوه استفاده از API: راهنما + آموزش برای مبتدیان

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

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

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

فهرست مطالب:

API چیست؟

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

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

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

بدون API، ما در واقع باید از نقشه های کاغذی استفاده کنیم تا راه خود را در هر جایی پیدا کنیم (و 100٪ مواقع گم می شوم). API ها به شما امکان می دهند بدون نیاز به اختراع مجدد چرخ به داده ها از منابع موجود دسترسی داشته باشید. بنابراین هنگامی که از برنامه ناوبری مورد علاقه خود استفاده می کنید، در واقع درخواستی را به دکل های تلفن همراه و سیستم های موقعیت یابی جهانی (GPS) ارسال می کنید تا به داده های مکان دسترسی داشته باشید.

در سمت توسعه نرم‌افزار، APIها میانبر ارائه می‌دهند که به توسعه‌دهندگان اجازه می‌دهد از قابلیت‌های از پیش ساخته شده استفاده کنند، بنابراین می‌توانند تلاش خود را بر ایجاد ویژگی‌های جدید متمرکز کنند. برای مثال، هواپیمایاب هواپیماها را در زمان واقعی ردیابی می کند. آنها به جای اینکه وقت خود را صرف ساختن نقشه جهان خود کنند، از Google Maps API استفاده کردند تا بتوانند وقت خود را صرف ویژگی های دیگر کنند.

API ها همچنین یکپارچه سازی بین سیستم های مختلف را تسهیل می کنند و تبادل یکپارچه داده ها را در بین برنامه ها امکان پذیر می کنند. وقتی کسب‌وکارها نیاز دارند اطلاعات را بین برنامه‌ها به اشتراک بگذارند، مانند اتصال شما، این کار مفید است CRM با ایمیل شما زاپیر از API برنامه ها برای ارائه هزاران ادغام بدون کد استفاده می کند، بنابراین همه برنامه های موجود در پشته فناوری شما می توانند با یکدیگر صحبت کنند (امیدواریم بدون خروج از خانه).

شروع کار با API ها

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

کلیدهای API

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

در ادامه به نحوه یافتن و استفاده از این کلیدها خواهیم پرداخت.

نقاط پایانی

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

یک ماشین خودکار را تصور کنید. شما می توانید تمام تنقلات مختلف داخل آن را ببینید و باید دکمه خاصی را فشار دهید تا اسنک مورد نظر خود را دریافت کنید. نقطه پایانی API مانند دکمه‌ای روی یک دستگاه فروش خودکار است که نشان‌دهنده بخش خاصی از اطلاعات یا عملکردی است که از API می‌خواهید. وقتی آن دکمه را با ارسال درخواست به نقطه پایانی API «فشار می‌دهید»، API می‌داند چه اطلاعات یا اقدامی را می‌خواهید و نوار Snickers (er, پاسخ) مورد نیاز را در اختیار شما قرار می‌دهد.

روش های درخواست

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

• گرفتن: این برای بازیابی داده های خاص از API استفاده می شود.

• پست: این به API می گوید که می خواهید داده های جدیدی را به سرور اضافه یا پست کنید.

• قرار دادن: این برای به روز رسانی منابع موجود در API استفاده می شود.

• حذف: این برای حذف داده های موجود از سرور استفاده می شود.

همچنین می‌توانید این درخواست‌ها را که به‌عنوان CRUD یا ایجاد، خواندن، به‌روزرسانی و حذف شناخته می‌شوند، مشاهده کنید. اکثر API های عمومی فقط به شما اجازه می دهند درخواست های GET (Read) را انجام دهید تا افراد را از خرابکاری با داده های خود دور نگه دارید. به هر حال، شما فقط کسی را نمی خواهید ورود به API هواشناسی و تغییر داده های آب و هوا.

تماس های API

فراخوانی API فرآیند ایجاد یک درخواست است، API داده‌های درخواستی شما را بازیابی می‌کند و سپس پاسخی از API دریافت می‌کند. تنها کاری که باید انجام دهید این است که درخواست را با استفاده از یکی از روش های HTTP بالا انجام دهید.

زمانی که در کافی شاپ نوشیدنی سفارش می دهید فکر کنید. شما به باریستا می گویید چه می خواهید، آنها سفارش شما را وارد سیستم می کنند و سپس باریستا نوشیدنی را به شما می دهد. یک فراخوانی API به همین ترتیب کار می کند – با نتیجه کمتر کافئین.

کدهای وضعیت

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

نحوه استفاده از API

من از Python (3) برای نشان دادن مثالی از استفاده از یک API استفاده خواهم کرد. می‌توانید از زبان‌های برنامه‌نویسی دیگر استفاده کنید، و حتی پلتفرم‌های API مبتدی مانند Postman یا RapidAPI (برای مک‌ها) وجود دارند که رابط‌های کاربرپسند را برای APIها ارائه می‌دهند. اما پایتون یک راه بسیار قابل دسترس برای استفاده از APIها است، حتی اگر کاملاً به این زبان مسلط نباشید.

1. یک API انتخاب کنید

هزاران API عمومی برای استفاده در دسترس هستند. شما می توانید دایرکتوری هایی مانند GitHub یا API Explorer گوگل برای پیدا کردن مواردی که به شما علاقه دارند اگر به دنبال یک API خاص هستید، اکثر سایت ها آنها را در زیر فهرست می کنند تنظیمات پیشرفته یا الف توسعه دهندگان بخش، اغلب در پایین سایت.

من از گوگل استفاده خواهم کرد Gmail API برای این آموزش

2. با اسناد API مشورت کنید

هر API باید برای شروع، نوعی اسناد را در اختیار شما قرار می دهد. معمولاً بخش مرجعی وجود دارد که اشیاء، پارامترها و نقاط پایانی مختلفی را که می‌توانید به آنها دسترسی داشته باشید، ارائه می‌کند. همچنین معمولاً یک مثال یا در مورد Gmail API، یک «شروع سریع» وجود دارد که به چند زبان رایج مختلف بیان شده است. این سند به شما می گوید:

در صورت وجود، کلید API را نیز در این سند خواهید یافت.

برای دنبال کردن این آموزش، باید:

1. پایتون 3.10.7 را نصب کنید (یا نسخه بعدی).

2. را نصب کنید پیپ مدیر بسته

3. ایجاد یک پروژه Google Cloud.

4. یک حساب جیمیل ایجاد کنید (اگر قبلاً ندارید).

3. یک درخواست بنویسید

اکنون زمان آن است که یک درخواست بنویسید یا به API بگویید که می خواهید چه کاری انجام دهد. اینجاست که متدهای GET، POST، PUT و DELETE وارد عمل می شوند.

در اینجا نحوه انجام یک درخواست GET از API Gmail با استفاده از کد boilerplate ارائه شده توسط Google آورده شده است. با این کار برچسب هایی که در Gmail ذخیره کرده اید در کنسول خود بازیابی و ثبت می شود.

1. نمونه کد شروع سریع را کپی کنید.

   

2. یک ویرایشگر متن مانند باز کنید TextEdit برای مک یا دفترچه یادداشت برای ویندوز کد را در ویرایشگر متن قرار دهید.

3. ذخیره به عنوان sample.py در پوشه ای که همه فایل های این پروژه را در آن ذخیره خواهید کرد. به این دایرکتوری کاری شما می گویند.

4. کلاینت خط فرمان خود را باز کنید—پایانه برای مک یا خط فرمان برای ویندوز—و به دایرکتوری کاری خود بروید. (نکته: در ترمینال تایپ کنید سی دی + فاصله سپس پوشه پروژه خود را از فایل سیستم خود به ترمینال بکشید و فشار دهید وارد.)

5. تایپ پایتون 3 sample.py و ضربه بزنید وارد.

   

اگر همه کارها را درست انجام دادید، باید تمام داده‌های برچسب جیمیل شما را جمع آوری کند.

نحوه اتصال یک برنامه به یک API

اگر می‌خواهید برنامه‌ها را با یک API ادغام کنید، همه مراحل بالا همچنان اعمال خواهند شد. اما شما همچنین نیاز دارید:

1. اسناد API را برای برنامه‌هایی که می‌خواهید متصل کنید پیدا کنید.

2. کلید API را (در صورت وجود) پیدا کنید.

3. از پروتکل لیست شده (به عنوان مثال، نصب وابستگی ها) در اسناد پیروی کنید.

4. از یک خط فرمان برای اجرای درخواست و برگرداندن پاسخ API استفاده کنید.

البته، وقتی می‌توانید برنامه‌های خود را با استفاده از Zapier متصل کنید، واقعاً نیازی به این همه مشکل ندارید.

REST در مقابل GraphQL در مقابل APIهای SOAP

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

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

• SOAP (پروتکل دسترسی به شی ساده) API برای برقراری ارتباط از XML (زبان نشانه گذاری توسعه پذیر)، نوعی زبان برنامه نویسی استفاده کنید. آنها رویکرد استاندارد شده برای برقراری ارتباط بین برنامه های کاربردی نرم افزاری مختلف در اوایل دهه 2000 بودند. از آن زمان محبوبیت آنها به طور قابل توجهی کاهش یافته است، زیرا در مقایسه با جایگزین هایی مانند REST و GraphQL پیچیده تر و غیر قابل انعطاف هستند.

انواع API ها

چهار روش برای دسته بندی API ها وجود دارد که هر کدام دارای کاربران و امتیازات خاص خود هستند.

• باز کردن API ها: اینها APIهای عمومی هستند که به توسعه دهندگان امکان دسترسی به خدمات یا داده های پلتفرم را می دهند. آنها همچنین برای ادغام شخص ثالث در دسترس هستند.

• API های شریک: این یک نوع API است که برای شرکا یا نهادهای شخص ثالث منتخب ایجاد شده است. آنها دسترسی محدودی به عملکردها یا داده های خاص را فراهم می کنند، اغلب برای یکپارچه سازی بین پلت فرم و شرکای آن.

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

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

  • مثال: با Twilio API، چندین کانال ارتباطی ادغام شده‌اند که به کاربران اجازه می‌دهد راه‌حل‌های ارتباطی جامع با یک API ایجاد کنند.

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

مقالات مرتبط: