به محتوای اصلی

شروع سریع

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

همین مسیر را قدم‌به‌قدم در ویدیو هم می‌توانید ببینید:

اولین API شما، از صفر۵:۲۹با صدای گوینده و زیرنویسقدم‌ها و متن کامل ویدیو

۱. ثبت‌نام و ساخت پروژه

بعد از ثبت‌نام، روی پروژهٔ جدید بزنید. می‌توانید از یک قالب آماده (فروشگاه، وبلاگ، رزرو و…) شروع کنید یا بوم خالی را انتخاب کنید. یک نام و یک نشانی (slug) برای پروژه انتخاب می‌کنید؛ slug در آدرس API شما ظاهر می‌شود:

https://api.fikaro.ir/{slug}/v1/...

۲. تعریف مدل داده

سریع‌ترین مسیر: در پروژهٔ تازه، دستیار هوش مصنوعی را باز کنید و کسب‌وکارتان را به فارسی توصیف کنید — جدول‌ها با سطح دسترسی پیشنهاد می‌شوند، شما تأیید می‌کنید و مدل داده و دادهٔ نمونه ساخته می‌شود. جزئیات در دستیار هوش مصنوعی. قدم‌های ۲ و ۳ همین کار به‌شکل دستی‌اند.

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

۳. اعمال تغییرات

روی ذخیره و اعمال بزنید. فیکارو پیش‌نمایش تغییرات را نشان می‌دهد و می‌گوید کدام تغییر ایمن و کدام مخرب است. بعد از تأیید، اندپوینت‌ها همان لحظه فعال می‌شوند — بدون build و بدون توقف سرویس.

۴. کلید API

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

ساختن کلید و فرستادن اولین درخواست با آن، قسمت دوم همان ویدیو است:

API شما، از کد خودتان۳:۰۴با صدای گوینده و زیرنویسقدم‌ها و متن کامل ویدیو

۵. اولین درخواست

curl https://api.fikaro.ir/{slug}/v1/product \
  -H "Authorization: Bearer apck_..."

و ساخت اولین رکورد:

curl -X POST https://api.fikaro.ir/{slug}/v1/product \
  -H "Authorization: Bearer apck_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "محصول اول", "price": 250000}'

لازم نیست curl بنویسید: داخل مستندات هر پروژه، هر اندپوینت یک پنل «آزمایش زنده» دارد که همین درخواست را با کلید اصلی پروژه از مرورگر اجرا می‌کند.

بعدش چه؟

  • مدل داده را عمیق‌تر بشناسید: قیدها، فیلد محاسباتی و روابط.
  • با قوانین، منطق تجاری (اعتبارسنجی و محرک‌ها) اضافه کنید.
  • کاربران اپ را ثبت‌نام و وارد کنید: آموزش ورود و توکن قدم به قدم پیش می‌رود.
  • برای کاری که API آماده انجام نمی‌دهد، مثل فرم تماس یا سرویس بیرونی، یک فانکشن بنویسید.
  • عکس و فایل را با آپلود فایل بفرستید و شناسه‌اش را در رکورد نگه دارید.
  • از خروجی‌ها و SDK، کالکشن Postman یا کلاینت تایپ‌شده بگیرید.
  • روایتِ همین مسیر با جزئیات هر قدم: ساخت API بدون کدنویسی.