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

شروع سریع

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

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

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

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

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

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

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

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

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

۴. ساخت کلید API

از صفحهٔ کلیدهای API یک کلید بسازید:

  • کلید Playground برای آزمایش — سقف نرخ محدود دارد و برای شروع کافی است.
  • کلید Production برای محیط واقعی — فقط یک بار نمایش داده می‌شود؛ همان موقع کپی‌اش کنید.

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

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 بنویسید: داخل مستندات هر پروژه، هر اندپوینت یک پنل «آزمایش زنده» دارد که همین درخواست را با کلید Playground از مرورگر اجرا می‌کند.

بعدش چه؟