آموزش کار با API برای مبتدی، از صفر تا اولین اتصال

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

✍️ عرفان فرنود۶ دقیقه مطالعهبه‌روزرسانی: ۱۳ مهر ۱۴۰۵
آموزش API برای مبتدی

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

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

API دقیقاً چیست

فرض کنید در یک رستوران نشسته‌اید. شما به آشپزخانه نمی‌روید، غذا را خودتان نمی‌پزید و اصلاً لازم نیست بدانید داخل آشپزخانه چه خبر است. یک گارسون هست، یک منو هست، شما سفارش می‌دهید و غذا می‌آید.

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

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

اگر مفهوم مقابلش را نمی‌شناسید، وب هوک چیست را هم بخوانید. آنجا سرویس مقابل به شما خبر می‌دهد؛ اینجا شما هستید که می‌پرسید.

چهار چیزی که هر درخواست دارد

هر درخواست API، هر چقدر هم پیچیده به‌نظر برسد، از همین چهار قطعه ساخته شده.

آدرس جایی است که درخواست را می‌فرستید. مثل نشانی یک مغازه. هر کاری که سرویس انجام می‌دهد، آدرس خودش را دارد.

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

احراز هویت ثابت می‌کند شما اجازه دارید. معمولاً یک کلید مخفی است که سرویس به شما می‌دهد و باید در هر درخواست همراهش بفرستید. این کلید مثل رمز حساب بانکی است؛ در ادامه می‌بینیم چرا.

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

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

آموزش کار با API برای مبتدی: اولین اتصال واقعی

بهترین راه یاد گرفتن، انجام دادن یک کار کوچک واقعی است. مسیر پیشنهادی من این است.

مستندات سرویس مورد نظرتان را باز کنید و دنبال بخشی بگردید که معمولاً «شروع سریع» نام دارد. تقریباً همیشه یک نمونه‌ی آماده در آن هست که فقط باید کلید خودتان را جایش بگذارید.

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

ساده‌ترین درخواست ممکن را بزنید؛ چیزی که فقط اطلاعات می‌خواند و چیزی را تغییر نمی‌دهد. مثلاً «مشخصات حساب من را بده». اگر این یکی جواب داد، یعنی آدرس و کلید هر دو درست هستند و بقیه‌ی راه فقط تغییر جزئیات است.

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

نکته‌ای که کار را خیلی سریع‌تر می‌کند: متن کامل خطا را به هوش مصنوعی بدهید و بگویید چه کار می‌خواستید بکنید. تشخیص این نوع خطاها دقیقاً همان چیزی است که مدل‌ها در آن خوب هستند.

کلیدها را جدی بگیرید

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

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

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

نکته‌ی آخر: بیشتر سرویس‌ها اجازه می‌دهند برای هر پروژه کلید جدا بسازید. این کار را بکنید. اگر روزی یکی درز کرد، فقط همان یک پروژه را باطل می‌کنید، نه همه‌چیز را.

اگر می‌خواهید این اتصال‌ها برای کسب‌وکارتان از ابتدا امن و مرتب چیده شود، می‌توانید درخواست مشاوره بدهید. همین اصول در چیدمان ماژول‌های XOS هم رعایت شده است.

مقالات مرتبط

بعد از اولین اتصال API، این مقاله‌ها کمک می‌کنند آن را به یک اتوماسیون کامل تبدیل کنید:

سوالات متداول

برای آموزش کار با API برای مبتدی باید زبان برنامه‌نویسی بلد باشم؟

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

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

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

API رایگان است؟

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

فرق API با وب‌هوک را کِی باید بدانم؟

از همان ابتدا. اگر شما می‌پرسید، API است؛ اگر سرویس مقابل خبر می‌دهد، وب‌هوک. بیشتر سیستم‌های واقعی هر دو را کنار هم دارند.

قدم بعدی

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

اگر می‌خواهید اول ببینید ساختن با هوش مصنوعی در عمل چه شکلی است، ویدیوی کامل آموزش کلاد را تماشا کنید؛ نزدیک یک ساعت، قدم‌به‌قدم.

نکته‌های کوتاه‌تر هم در کانال یوتیوب منتشر می‌شود.

می‌خواهی این‌ها را عملی یاد بگیری؟

دوره‌ی سفر هوش مصنوعی: ۷ فصل پروژه‌محور از صفر تا درآمد.

نظرها

  • اولین نفری باش که نظر می‌دهد.

مقالات مرتبط