رایبان CRM

API و وب‌هوک CRM

API و وب‌هوک برای اتصال رایبان به سیستم‌های دیگر

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

داده‌ای که بین سایت، فرم و CRM دستی جابه‌جا می‌شود

فرم تماس سایت به ایمیل می‌رود، سفارش در سیستم دیگری است و کسی باید همه را در CRM کپی کند. با API و وب‌هوک، سرنخ‌ها خودشان وارد می‌شوند و هر تغییر مهم به سیستم‌های دیگر شما خبر داده می‌شود.

روش کار

API و وب‌هوک در رایبان چطور کار می‌کند؟

  1. مرحله 1

    ساخت کلید API

    مالک یا مدیر میزکار در «اتصال‌ها و API» کلید «فقط خواندن» یا «خواندن و نوشتن» می‌سازد؛ کلید یک بار نمایش داده می‌شود و فقط به همان میزکار دسترسی دارد.

  2. مرحله 2

    خواندن و ثبت داده

    با ‎/api/v1‎ مشتری، فرصت فروش و پیش‌فاکتور را فهرست، ثبت و ویرایش کنید؛ ثبت مشتری با upsert بر اساس شماره تکراری نمی‌سازد. سقف: ۱۲۰ درخواست در دقیقه برای هر کلید.

  3. مرحله 3

    تعریف وب‌هوک

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

  4. مرحله 4

    دریافت امن

    هر رویداد با امضای HMAC-SHA256 در هدر X-Rayban-Signature فرستاده می‌شود و اگر پاسخ 2xx نباشد تا ۵ بار دیگر تلاش می‌شود؛ گزارش ارسال‌ها در همان صفحه است.

  5. مرحله 5

    فرم جذب سرنخ سایت

    یک فرم بسازید و کد HTML آن را در سایت بگذارید؛ هر ارسال، مشتری با منبع «سایت» و در صورت انتخاب، فرصت فروش می‌سازد.

صفحه اتصال‌ها و API در میزکار رایبان روی گوشی با کلیدهای API و وب‌هوک‌ها
تصویر واقعی از نسخه موبایل (داده نمونه)

مستندات برای توسعه‌دهندگان

روی گوشی

ساخت کلید، وب‌هوک و فرم سرنخ از صفحه «اتصال‌ها و API» روی گوشی هم ممکن است و سرنخ‌های تازه همان لحظه در فهرست مشتریان گوشی دیده می‌شوند. رایبان وب‌اپ (PWA) است و بدون نصب از فروشگاه، از صفحه اصلی گوشی اندروید یا آیفون باز می‌شود.

در کدام پلن هست؟

API، وب‌هوک و فرم جذب سرنخ در همه پلن‌ها (برنزی، نقره‌ای و طلایی) و در دوره آزمایش ۳۰ روزه فعال است.

تعرفه و مقایسه پلن‌ها

امکانات مرتبط

اتصال‌های دیگر رایبان

همه امکانات رایبان ←

سوالات API و وب‌هوک

API رایبان به چه داده‌هایی دسترسی می‌دهد؟+

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

وب‌هوک‌ها برای چه رویدادهایی فرستاده می‌شوند؟+

customer.created، customer.updated، deal.created، deal.updated، quote.created، quote.updated، ticket.created و ticket.updated.

اگر سرور من در دسترس نباشد رویداد گم می‌شود؟+

اگر پاسخ 2xx نباشد، رایبان تا ۵ بار دیگر با فاصله فزاینده (از ۱ دقیقه تا ۶ ساعت) دوباره می‌فرستد و نتیجه هر ارسال در گزارش وب‌هوک‌ها دیده می‌شود. آدرس‌های داخلی و IP خصوصی پذیرفته نمی‌شوند.

فرم جذب سرنخ جلوی اسپم را می‌گیرد؟+

فرم یک فیلد تله (honeypot) دارد و هر بازدیدکننده حداکثر ۵ ارسال در دقیقه دارد. اگر شماره قبلاً ثبت شده باشد، مشتری تکراری ساخته نمی‌شود و درخواست به‌صورت یادداشت روی همان مشتری می‌نشیند.

فرق API با اتصال هوش مصنوعی (MCP) چیست؟+

API برای برنامه‌نویس‌ها و سیستم‌های دیگر است. MCP برای اتصال دستیارهایی مثل ChatGPT و Claude است که به فارسی از آن‌ها سؤال می‌کنید؛ راهنمای آن در صفحه MCP توسعه‌دهندگان است.