API و وبهوک داتیک راهنمای شروع برای تیم فنی
داتیک برای کار با رکوردها از REST و GraphQL و برای تبادل رویداد از وبهوک پشتیبانی میکند. پیش از پیادهسازی، عملیات مجاز، قرارداد داده و روش احراز هویت را برای نسخه و محیط استقرار مشخص کنید.
کدام مسیر برای یکپارچهسازی مناسب است؟
REST یا GraphQL برای تبادل رکورد
نوع شیء، فیلدهای ضروری، عملیات خواندن یا نوشتن و دسترسی حساب سرویس را با تیم استقرار مشخص کنید.
وبهوک برای تبادل رویداد
داتیک میتواند رویدادی را به سامانه دیگر اعلام کند یا از یک رویداد خارجی برای آغاز گردش کار استفاده کند. رویدادهای فعال را روی محیط پروژه بررسی کنید.
تطبیق و بازیابی
شناسهای برای ارتباط دو رکورد در نظر بگیرید و قبل از بهرهبرداری، خطای داده، وقفه ارتباط و دریافت تکراری را جداگانه تست کنید.
نمونه مفهومی ثبت سرنخ و دریافت شناسه
در این سناریوی فرضی، یک سامانه بیرونی سرنخ را میفرستد و شناسه نتیجه را کنار رکورد خودش نگه میدارد. جهت و مسئول هر مرحله را ابتدا در قرارداد اتصال مشخص کنید.
| مرحله | ورودی یا خروجی نمونه | کنترل پیشنهادی |
|---|---|---|
| درخواست ثبت | شناسه رکورد مبدأ، عنوان سرنخ و کانال ورودی | فیلدهای لازم، مجوز نوشتن و نوع داده بررسی شوند. |
| پاسخ ثبت | وضعیت موفق و شناسه رکورد مقصد | شناسه مقصد کنار شناسه مبدأ ذخیره شود. |
| خطا یا ارسال مجدد | خطای مجوز، فیلد نامعتبر یا وقفه شبکه | قبل از تلاش دوباره، وضعیت ثبت رکورد در مقصد را بررسی کنید. |
نام فیلدها در نمونه قراردادی فرضیاند. نشانی API، روش احراز هویت، نام فیلدها، قالب پاسخ و فهرست رویدادها را از مستندات همان محیط استقرار دریافت کنید.
مشاهده نمونه مفهومی درخواست و پاسخ
Example request data
{
"external_id": "LEAD-1042",
"title": "Project inquiry",
"channel": "website"
}
Example recorded result
{
"status": "created",
"external_id": "LEAD-1042",
"crm_record_id": "CRM-782"
}
پیش از اتصال چه چیزهایی را از تیم استقرار بگیریم؟
- قرارداد نسخه و دسترسی
نشانی محیط آزمون، عملیات و فیلدهای مجاز، نحوه احراز هویت، شیوه اعتبارسنجی وبهوک و محدودیت ارسال را دریافت کنید.
- رفتار خطا و ثبت رخداد
برای درخواست ردشده و قطع شبکه، قواعد تلاش مجدد و ثبت خطا را تعریف کنید. اطلاعات حساس را در لاگ ذخیره نکنید.
سؤالات متداول
آیا نمونه این صفحه را میتوان مستقیماً اجرا کرد؟
نمونه، شکل مفهومی تبادل داده را نشان میدهد. برای اجرای واقعی باید قرارداد فنی، نشانی و دسترسی همان محیط را دریافت کنید.
آیا اشیای سفارشی داتیک هم از طریق API در دسترساند؟
بله، دسترسی API به اشیا و فیلدها از جمله ساختار سفارشی تابع مجوزهای مربوط است. مدل و فیلدهای واقعی در محیط استقرار مشخص میشوند.
از وبهوک برای دریافت و ارسال رویداد میتوان استفاده کرد؟
داتیک از اعلام رویداد به بیرون و شروع گردش کار بر اساس رویداد بیرونی پشتیبانی میکند. نام رویداد، جهت و پیکربندی هرکدام را در پروژه بررسی کنید.
قرارداد اتصال به سامانه خودتان را بررسی کنید
سامانه مقصد، جهت تبادل، نوع رکورد و عملیات مدنظر را بنویسید. رمز یا توکن را در فرم وارد نکنید.



