تغییرات API

هر تغییر API و وب‌هوک اینجا ثبت می‌شود. تغییر ناسازگار فقط در نسخهٔ تازه (/api/v2) می‌آید و از قبل همین‌جا اعلام می‌شود.

  1. 2026-10-26
    افزوده

    ساخت یا ویرایش مخاطب در یک درخواست

    • POST /contacts/upsert: اگر مخاطبی با کلیدهای شناسایی کسب‌وکار (به‌طور پیش‌فرض موبایل و بعد ایمیل) پیدا شود ویرایش می‌شود، وگرنه ساخته می‌شود.
    • پاسخ { created, contact } است.
  2. 2026-10-24
    افزوده

    رویدادهای نوبت

    • دو رویداد وب‌هوک تازه: booking.created و booking.cancelled.
  3. 2026-09-27
    افزوده

    وب‌هوک‌های امضاشده

    • ۱۶ رویداد برای مخاطب، شرکت، سرنخ، محصول، معامله، سفارش و فرم.
    • امضای HMAC-SHA256 در سرآیند Reshta-Signature.
    • تلاش دوباره تا حدود ۲۴ ساعت؛ غیرفعال شدن پس از ۲۰ شکست پشت‌سرهم، بی‌آنکه ارسالی دور ریخته شود.
  4. 2026-09-27
    افزوده

    API عمومی، نسخهٔ ۱

    • مخاطبان، شرکت‌ها، معاملات و سفارش‌ها: فهرست، دریافت، ساخت و ویرایش؛ و یادداشت روی مخاطب، شرکت و معامله.
    • کلید API با دسترسی «خواندن» یا «خواندن و نوشتن»؛ ۱۲۰ درخواست در دقیقه برای هر کلید.
    • Idempotency-Key در همهٔ درخواست‌های نوشتنی الزامی است.
    • صفحهٔ «اتصال ← توسعه‌دهنده» در اپ: ساخت و ابطال کلید، وب‌هوک‌ها، تاریخچهٔ ارسال و «ارسال دوباره».
    • فایل OpenAPI در /api/v1/public/openapi.json.

در برنامه

این ماژول‌ها در حال ساخت‌اند و هنوز endpoint عمومی ندارند. هر کدام که endpointهایش در فایل OpenAPI بیاید، خودکار از این فهرست بیرون می‌رود و در مرجع API فعال می‌شود.

  • سرنخ‌هابه‌زودی
  • محصولاتبه‌زودی
  • فعالیت‌هابه‌زودی
  • نوبت‌هابه‌زودی
  • پرداخت‌هابه‌زودی
  • فرم‌هابه‌زودی
  • فیلدهابه‌زودی
  • تماس‌هابه‌زودی
  • پیام‌هابه‌زودی

کلید API بسازید و اولین درخواست را بفرستید

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

  1. ۱ورود به app.reshta.ir
  2. ۲اتصال ← توسعه‌دهنده
  3. ۳ساخت کلید API