API و وب‌هوک در ERP آبان۳۶۰

درخواست و رویداد را با قرارداد روشن میان سامانه‌ها مبادله کنید

API مسیر درخواست قابلیت یا داده را فراهم می‌کند و وب‌هوک می‌تواند وقوع رویداد را به مقصد اعلام کند.

راهنمای API و وب‌هوکحدود ۸ دقیقه مطالعه
بررسی اتصال نرم‌افزارها و دسترسی از رایانه و موبایل
API و وب‌هوکبخشی از مدیریت یکپارچه سازمان
شناخت راهکار

API و وب‌هوک؛ از نیاز روزمره تا فرایندی منظم

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

جایگاه این قابلیت در آبان۳۶۰

اتصال آبان۳۶۰ به ابزارهای دیگر و استفاده در دستگاه یا زبان متفاوت به دامنه نسخه، امکانات طرف مقابل و تنظیمات وابسته است. پیش از تصمیم، ورودی، خروجی، هویت و تجربه واقعی کاربر را در یک سناریوی مشترک بررسی کنید.

امکانات و کاربردها

آنچه در این بخش دنبال می‌کنید

نسخه رابط

در «نسخه رابط»، مبنا و اطلاعات لازم را مشخص کنید. نسخه رابط، ساختار پیام، شناسه رویداد، روش احراز، محدودیت مصرف و پاسخ مورد انتظار را مشخص کنید.

اعتبار پیام

«اعتبار پیام» را با قرارداد تبادل، نمونه داده و مسیر استفاده در مقصد هماهنگ کنید تا اعضای تیم از یک تعریف مشترک استفاده کنند.

تلاش مجدد

برای «تلاش مجدد»، مسئول به‌روزرسانی و زمان بازبینی را تعیین کنید. رویداد تکراری نباید اثر ناخواسته تکراری ایجاد کند.

کنترل اثر تکراری

«کنترل اثر تکراری» باید به نتیجه مرحله «ثبت نتیجه و مدیریت خطا» کمک کند؛ مدرک تصمیم و موارد نیازمند ادامه کار را روشن نگه دارید.

یک موقعیت واقعی کاری

API و وب‌هوک در جریان کار سازمان

پس از تغییر وضعیت درخواست، رویداد به مقصد می‌رسد؛ گیرنده با شناسه رویداد تکرار را تشخیص می‌دهد و نتیجه پردازش یا خطا را در مسیر قابل پیگیری ثبت می‌کند.

بررسی سناریوی سازمان شما ←
آبان۳۶۰API و وب‌هوک
اطلاعات مشخصمستندات مرتبطسابقه قابل مراجعه
موضوع کنترلمرحله نمونهنقش مرتبط
نسخه رابطتعریف اولیهمدیر سامانه
اعتبار پیامدر حال بررسیمسئول فناوری
تلاش مجددنیازمند تأییدمالک خدمت

دامنه، مسئول و نتیجه بررسی در یک مسیر قابل پیگیری

نمای شماتیک برای توضیح فرایند؛ تصویر واقعی محیط سامانه نیست.
مسیر انجام کار

از شروع تا سابقه‌ای قابل پیگیری

  1. ۱

    تعریف قرارداد و احراز

  2. ۲

    ارسال درخواست یا رویداد

  3. ۳

    پردازش و کنترل تکرار

  4. ۴

    ثبت نتیجه و مدیریت خطا

فراتر از یک ابزار جداگانه

API و وب‌هوک در یک ERP یکپارچه

اتصال آبان۳۶۰ به ابزارهای دیگر و استفاده در دستگاه یا زبان متفاوت به دامنه نسخه، امکانات طرف مقابل و تنظیمات وابسته است. پیش از تصمیم، ورودی، خروجی، هویت و تجربه واقعی کاربر را در یک سناریوی مشترک بررسی کنید.

شناسه پیگیری، نتیجه پردازش و خطا را میان مسئولان مبدأ و مقصد قابل تطبیق نگه دارید. در تغییر قرارداد یا رابط، کاربران و نگهدارندگان باید بدانند چه چیزی عوض شده و برای داده یا عملیات نیمه‌تمام چه تصمیمی گرفته می‌شود.

۱ / راهنمای API و وب‌هوک

اطلاعات و پیش‌نیازهای API و وب‌هوک

نسخه رابط، ساختار پیام، شناسه رویداد، روش احراز، محدودیت مصرف و پاسخ مورد انتظار را مشخص کنید. برای تلاش مجدد، ترتیب رویدادها و ثبت نتیجه در مقصد قرارداد روشن داشته باشید.

پیش از شروع، قرارداد تبادل، نمونه داده و مسیر استفاده در مقصد را همراه یک نمونه از کار جاری آماده کنید. تفاوت اطلاعات ضروری برای اجرا و داده‌های صرفاً گزارشی را مشخص کنید؛ ثبت اطلاعات بیشتر زمانی مفید است که مسئول نگهداری و کاربرد آن روشن باشد.

۲ / راهنمای API و وب‌هوک

کنترل‌های مهم و خطاهای رایج در API و وب‌هوک

رویداد تکراری نباید اثر ناخواسته تکراری ایجاد کند. اعتبار پیام ورودی و اختیار فرستنده را کنترل کنید؛ قطع اتصال، پاسخ دیرهنگام و تغییر نسخه باید در سناریوی آزمون قرارداد دیده شوند.

در مسیر «ارسال درخواست یا رویداد» تا «پردازش و کنترل تکرار»، اگر اطلاعات ناقص یا تصمیم متناقض وجود داشت، علت و مسئول پیگیری را ثبت کنید. اصلاح سابقه باید از نتیجه نهایی قابل تشخیص باشد؛ تغییر بی‌توضیح وضعیت، امکان یادگیری از ارزیابی خروجی را کاهش می‌دهد.

۳ / راهنمای API و وب‌هوک

همکاری تیم و تحویل نتیجه در API و وب‌هوک

شناسه پیگیری، نتیجه پردازش و خطا را میان مسئولان مبدأ و مقصد قابل تطبیق نگه دارید. در تغییر قرارداد یا رابط، کاربران و نگهدارندگان باید بدانند چه چیزی عوض شده و برای داده یا عملیات نیمه‌تمام چه تصمیمی گرفته می‌شود.

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

۴ / راهنمای API و وب‌هوک

سناریوی بررسی API و وب‌هوک برای سازمان شما

مسیر موفق، داده نامعتبر و قطع ارتباط را در سناریوی بررسی قرار دهید. نتیجه باید به کاربر و تیم پشتیبان نشان دهد عملیات انجام شده، منتظر ادامه است یا شکست خورده؛ ابهام در این وضعیت می‌تواند به اقدام تکراری منجر شود.

مسیر «تعریف قرارداد و احراز»، «ارسال درخواست یا رویداد»، «پردازش و کنترل تکرار»، «ثبت نتیجه و مدیریت خطا» را با داده نمونه سازمان مرور کنید. در پایان باید بتوانید ورودی، مسئول، خروجی و استثنای هر مرحله را توضیح دهید. معیار موفقیت، رسیدن به نتیجه قابل بررسی است؛ صرف ثبت ردیف یا ارسال اعلان کافی نیست.

پیش از جلسه بررسی API و وب‌هوک آماده کنید

  • نمونه‌ای از قرارداد تبادل، نمونه داده و مسیر استفاده در مقصد با حذف اطلاعات محرمانه غیرضروری.
  • تعریف تیم برای نسخه رابط و اعتبار پیام و یک نمونه صحیح از هرکدام.
  • نقش مسئول ارسال درخواست یا رویداد، تأییدکننده و روش رسیدگی به برگشت یا اصلاح.
  • یک مورد استثنا و نشانه قابل بررسی برای پایان مرحله ثبت نتیجه و مدیریت خطا.
پیش از انتخاب

پرسش‌های متداول API و وب‌هوک

پاسخ‌های کوتاه برای شناخت بهتر دامنه این بخش و آماده‌شدن برای بررسی نیاز سازمان.

برای شروع API و وب‌هوک چه اطلاعاتی لازم است؟

نسخه رابط، ساختار پیام، شناسه رویداد، روش احراز، محدودیت مصرف و پاسخ مورد انتظار را مشخص کنید. برای تلاش مجدد، ترتیب رویدادها و ثبت نتیجه در مقصد قرارداد روشن داشته باشید.

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

رویداد تکراری نباید اثر ناخواسته تکراری ایجاد کند. اعتبار پیام ورودی و اختیار فرستنده را کنترل کنید؛ قطع اتصال، پاسخ دیرهنگام و تغییر نسخه باید در سناریوی آزمون قرارداد دیده شوند.

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

مالک فرایند، مسئول اتصال و نماینده کاربران مقصد باید درباره معیار نتیجه، نقش‌ها و اطلاعات موردنیاز توافق کنند. شناسه پیگیری، نتیجه پردازش و خطا را میان مسئولان مبدأ و مقصد قابل تطبیق نگه دارید. در تغییر قرارداد یا رابط، کاربران و نگهدارندگان باید بدانند چه چیزی عوض شده و برای داده یا عملیات نیمه‌تمام چه تصمیمی گرفته می‌شود.

این بخش چگونه با دیگر ماژول‌های آبان۳۶۰ مرتبط می‌شود؟

اتصال آبان۳۶۰ به ابزارهای دیگر و استفاده در دستگاه یا زبان متفاوت به دامنه نسخه، امکانات طرف مقابل و تنظیمات وابسته است. پیش از تصمیم، ورودی، خروجی، هویت و تجربه واقعی کاربر را در یک سناریوی مشترک بررسی کنید.

در جلسه معرفی چه سناریویی را مرور کنیم؟

نمونه‌ای مشابه این موقعیت آماده کنید: پس از تغییر وضعیت درخواست، رویداد به مقصد می‌رسد؛ گیرنده با شناسه رویداد تکرار را تشخیص می‌دهد و نتیجه پردازش یا خطا را در مسیر قابل پیگیری ثبت می‌کند. سپس توضیح دهید کدام مرحله اکنون خارج از مسیر رسمی پیگیری می‌شود و چه خروجی‌ای برای تیم لازم است.

در ادامهٔ اتصال‌ها و دسترسی چندسکویی

قدم بعدی، شناخت نیاز شما

دربارهٔ نیاز سازمانتان گفت‌وگو کنیم

نمونه فرایندها و انتظار شما از API و وب‌هوک را با هم بررسی می‌کنیم تا دامنه مناسب سازمانتان مشخص شود.

۰۲۱–۹۱۰۹۹۱۷۴