Skip to main content

این مجموعه مستندات چیست؟

این‌جا مرجع فنی کامل و متمرکز برای هر نوع اینتگریشن با نرم افزار دیدار است، شما قرار است خودتان با تکیه بر همین مستندات بتوانید اینتگریشن خود را از صفر تا آصد پیاده‌سازی کنید. این مجموعه شامل این بخش‌هاست:
  • راهنمای توسعه‌دهنده (همین بخش) — مفاهیم پایه دیدار و نکات عمومی شروع کار با API، پیش‌نیاز فهم بقیه بخش‌ها
  • API Reference — مستند دقیق تک‌تک Endpointهای دیدار: چه Requestای باید بسازید، چه Responseای برمی‌گردد، چه فیلدهایی الزامی‌اند و هرکدام از این فیلدها به چه معنایی هستند
  • Webhook Reference — رویدادهایی که دیدار می‌تواند به شما اطلاع بدهد و ساختار دقیق Payload هرکدام
  • مستندات نودهای اختصاصی n8n — نحوه استفاده از دیدار در گردش‌کارهای n8n بدون نوشتن کد
هدف این است که این مستندات، قرارداد فنی رسمی و قابل‌اعتماد بین دیدار و شما باشد؛ چیزی که هم برای ساخت integration کافی است، هم می‌توانید به آن ارجاع بدهید.

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

برنامه نویسان

برنامه نویسانی که می‌خواهند دیدار را به یک سیستم یا سرویس دیگر (اپلیکیشن داخلی، وب‌سایت، سیستم مالی و…) وصل کنند.

کاربران فنی دیدار

افرادی که خودشان از دیدار به‌عنوان کاربر استفاده می‌کنند، دانش فنی هم دارند و می‌خواهند فرآیندهای تیم فروش یا پشتیبانی خودشان را با API یا Webhook خودکار کنند.

کاربران ابزارهای اتوماسیون

کسانی که با ابزارهایی مثل n8n کار کرده‌اند و می‌خواهند بدون نوشتن کد، دیدار را به گردش‌کارهای خودکار خودشان وصل کنند.

دیدار چه راه‌هایی برای یکپارچه‌سازی جلوی شما می‌گذارد؟

بسته به چیزی که می‌خواهید بسازید، یکی از این سه راه مناسب شماست:

مسیر پیشنهادی مطالعه

  1. همین صفحه
    یک تصویر کلی از دیدار و مسیر مطالعه به دست آوردید.
  2. مفاهیم پایه دیدار
    اجزای اصلی دیدار (شخص، شرکت، معامله، کاریز، فعالیت، محصول، فاکتور، پرونده) و رابطه‌شان با هم را یاد می‌گیرید. این صفحه پیش‌نیاز فهم درست همه صفحات بعدی است.
  3. شروع کار با اینتگریشن دیدار
    آدرس پایه، احراز هویت، ساخت کلید API، ساختار پاسخ‌ها و محدودیت‌ها را می‌بینید.
  4. براساس نیازتان ادامه دهید
    اگر با کد کار می‌کنید سراغ API Reference بروید. اگر می‌خواهید از رویدادهای آنی باخبر شوید سراغ Webhook. اگر بدون کد می‌سازید سراغ مستندات n8n.