یکپارچه‌سازی / Bizagi 11.2.5 On-Premises
چک‌لیست یکپارچه‌سازی API با فرآیندهای سازمانی
از قرارداد سرویس و احراز هویت تا timeout، retry، ثبت لاگ و مدیریت خطا؛ راهنمای طراحی اتصال پایدار میان BPMS و سامانه‌ها.
دامنه این آموزش: Bizagi Studio و Automation Server نسخه 11.2.5 On-Premises.
نکته نسخه: build دقیق 11.2.5 و تنظیمات محیط سازمان را پیش از اجرای تغییر در Test بررسی کنید. نسخه 11.2.5 از سپتامبر 2024 خارج از پشتیبانی رسمی Bizagi است؛ بنابراین تغییرات امنیتی و زیرساختی باید با ارزیابی ریسک انجام شوند.
یکپارچه‌سازی موفق از ارسال یک درخواست HTTP شروع نمی‌شود؛ از تعریف مسئولیت، قرارداد داده و رفتار سیستم هنگام شکست شروع می‌شود. فرآیند باید حتی در شرایط قطعی یا پاسخ نامعتبر سرویس، رفتار قابل پیش‌بینی داشته باشد.
مالک داده و مسئولیت را مشخص کنید
پیش از توسعه تعیین کنید کدام سامانه مرجع هر داده است. اگر اطلاعات پرسنلی در سامانه منابع انسانی مرجع است، BPMS نباید نسخه مستقل و ناسازگار آن را بدون برنامه همگام‌سازی نگهداری کند.
برای هر اتصال بنویسید:
قرارداد API را دقیق کنید
نمونه موفق و ناموفق پاسخ کافی نیست. وضعیت‌های HTTP، ساختار خطا، فیلدهای اجباری، محدودیت طول، encoding فارسی، منطقه زمانی و رفتار تغییر نسخه را ثبت کنید.
احراز هویت و اطلاعات محرمانه
Token، password و secret نباید داخل Rule، فرم یا کد فرانت‌اند قرار بگیرند. تنظیمات هر محیط باید جدا باشد. دسترسی سرویس نیز باید حداقل مجوز لازم را داشته باشد.
Bizagi برای Connectorها روش‌های احراز هویت مختلف ارائه می‌کند و Easy REST connectorها بخشی از حالت‌های OAuth 2.0 را پوشش می‌دهند؛ نیازهای خارج از آن ممکن است به Custom Connector نیاز داشته باشد.
همگام یا غیرهمگام؟
اگر کاربر برای ادامه فعالیت فوراً به پاسخ نیاز دارد، فراخوانی همگام منطقی است؛ اما باید timeout کوتاه و پیام مناسب داشته باشد. عملیات طولانی مانند پردازش سند یا ارسال انبوه بهتر است غیرهمگام باشد و نتیجه آن بعداً به فرآیند بازگردد.
Timeout، Retry و Idempotency
Retry بدون طراحی می‌تواند یک عملیات را چند بار اجرا کند. برای عملیات‌هایی مانند پرداخت، ثبت سند یا ایجاد سفارش، شناسه یکتای درخواست و رفتار idempotent ضروری است.
سیاست روشن تعریف کنید:
ثبت لاگ قابل استفاده
برای هر فراخوانی مهم، زمان، نام سرویس، Case ID، شناسه رهگیری، نتیجه، مدت پاسخ و خلاصه خطا را ثبت کنید. اطلاعات محرمانه و داده شخصی را کامل در لاگ ذخیره نکنید.
تست‌هایی که نباید حذف شوند
انتخاب روش اتصال
اگر API استاندارد و ساده است، Easy REST Connector گزینه کم‌هزینه‌تری است. اگر نیاز به کتابخانه جانبی، منطق احراز هویت خاص یا پردازش پیچیده دارید، Custom Connector مناسب‌تر است. اتصال مستقیم دیتابیس باید آخرین گزینه و با کنترل دقیق باشد.
منابع رسمی:
https://help.bizagi.com/platform/en/connectors_editor.htm
https://help.bizagi.com/platform/en/connectors_authentication.htm