اتصال و API

۱ اعتبار · استاندارد

همگام‌سازی بی‌‌درنگ داده‌ها با سیستم‌های خارجی از طریق API و وب هوک

با ایجاد کلیدهای اختصاصی API و تعیین دقیق مجوزهای دسترسی (Scopes)، امکان تبادل امن داده‌ها را برای سامانه‌های حسابداری، انبارداری و CRM ثالث فراهم کنید. همچنین با قابلیت وب هوک (Webhook)، کلیهٔ رویدادهای مهم نظیر ثبت سفارش، پرداخت موفق یا ارسال تیکت را به‌صورت آنی به سرویس‌های مقصد مخابره نمایید.

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

امکانات و قابلیت‌ها

جعبه‌ابزار جامع برای توسعه‌دهندگان و اتصال سامانه‌های سازمانی

کلیدهای اختصاصی API با رمزنگاری یک‌طرفه

تولید توکن‌های اختصاصی برای هر نرم‌افزار یا سرویس بیرونی؛ کلیدها صرفاً یک‌بار حین ساخت نمایش داده شده و به‌صورت کاملاً رمزنگاری‌شده (Hashed) ذخیره می‌شوند.

مجوزهای مجزا و تفکیک دسترسی‌ها (Scopes)

تعیین دقیق سطح دسترسی خواندن یا نوشتن (Read/Write) برای هر کلید؛ جلوگیری از دسترسی‌های غیرمجاز با اعمال محدودیت به ماژول‌های خاص مانند فروشگاه یا مشتریان.

چرخهٔ عمر کلید، تاریخ انقضا و ابطال آنی

امکان تعیین تاریخ انقضای دوره‌ای برای کلیدها، ابطال فوری توکن‌های سازش‌یافته در یک کلیک و ثبت دقیق تاریخچهٔ آخرین زمان فراخوانی.

وب هوک‌های آنی بر پایهٔ رویداد (Event-Driven Webhooks)

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

اعتبارسنجی ارسال با امضای دیجیتال (HMAC SHA-256)

تولید هدر امضاشدهٔ اختصاصی برای تمامی درخواست‌های وبهوک با استفاده از کلید محرمانه (Secret)، جهت راستی‌آزمایی اصالت پیام و جلوگیری از حملات جعل درخواست (Tampering).

سیاست تلاش مجدد خودکار و ثبت گزارش تحویل (Logs)

تلاش هوشمندانه و مجدد برای ارسال وبهوک‌های ناموفق با الگوریتم زمان‌بندی صعودی (Exponential Backoff)، همراه با لاگ جامع از کد وضعیت پاسخ (HTTP Status) و پاسخ سرور مقصد.

مدیریت کلیدهای API

مدیریت هوشمند توکن‌ها؛ اختصاص محدوده‌های مشخص برای هر اتصال

برای سامانه‌های انبارداری، نرم‌افزارهای حسابداری، داشبوردهای مدیریتی یا اپلیکیشن‌های اختصاصی، کلیدهای مجزا تعریف کنید و محدودهٔ عملکرد (Scopes) هر کلید را صرفاً به منابع موردنیازش (خواندن یا نوشتن) محدود نمایید. بدین ترتیب امنیت پایگاه داده تضمین شده و در صورت لزوم، هر توکن در هر لحظه تنها با یک کلیک قابل ابطال فوری است

  • تفکیک محدوده‌های دسترسی (Scopes) بر اساس خواندن یا نوشتن
  • تعیین تاریخ انقضای دوره‌ای برای افزایش ایمنی توکن‌ها
  • ثبت دقیق لاگ و تاریخچهٔ آخرین زمان فراخوانی کلید
ساخت کلید API

وب هوک‌های بلادرنگ (Webhooks)

یکپارچه‌سازی بر پایهٔ رویداد؛ اطلاع‌رسانی خودکار و لحظه‌ای به اندپوینت‌ها

اشتراک در رخدادهای کلیدی سامانه—از قبیل ثبت سفارش نهایی، پرداخت موفق فاکتور، رزرو نوبت یا جذب سرنخ جدید—را به‌سادگی فعال کنید. با وقوع هر اتفاق، پی‌لود اطلاعات بلافاصله در قالب ساختاریافتهٔ JSON همراه با امضای دیجیتال امن (HMAC) به آدرس‌های مقصد (URL) ارسال می‌شود تا سیستم‌های شما بدون وقفه به‌روزرسانی شوند.

  • پشتیبانی از فهرست جامع رخدادهای ماژول‌های پلتفرم
  • ارسال ساختاریافتهٔ داده‌ها در قالب JSON همراه با امضای امنیتی
  • امکان ارسال هم‌زمان رویداد به یک یا چند اندپوینت (URL)
افزودن وب‌هوک

تضمین تحویل داده‌ها (Delivery Guarantee)

مکانیزم صف‌بندی هوشمند و تلاش مجدد؛ بازیابی خودکار خطاهای شبکه

کلیهٔ پیام‌ها پیش از مخابره در یک صف پایدار (Persistent Queue) ذخیره می‌شوند. در صورت بروز اختلال، کندی شبکه یا عدم پاسخ‌گویی سرور مقصد، سامانه طبق الگوریتم زمان‌بندی هوشمند فرایند ارسال مجدد (Retry) را تکرار می‌کند. علاوه بر این، جزئیات کامل هدرها، بدنهٔ پاسخ و کدهای خطای HTTP در لاگ تحویل اختصاصی هر وبهوک به‌صورت زنده ثبت و قابل رهگیری است.

  • صف‌بندی پایدار رویدادها (Persistent Queue)
  • سیاست تلاش مجدد با فاصله‌گذاری تصاعدی (Exponential Backoff)
  • ثبت دقیق لاگ‌های تحویل، هدرها و کدهای وضعیت HTTP
گزارش تحویل وب‌هوک

استانداردهای امنیتی API

ارتباط امن و پایدار با نرم‌افزارهای خارجی بر پایهٔ آخرین پروتکل‌های حفاظتی

عدم ذخیره‌سازی متن خام کلیدها (One-time Display)

توکن محرمانه صرفاً یک‌بار در لحظهٔ ایجاد به توسعه‌دهنده نمایش داده می‌شود؛ در پایگاه داده تنها هش غیرقابل‌بازگشت کلید نگه‌داری می‌شود تا حتی در صورت نفوذ، امنیت دسترسی‌ها حفظ گردد.

محدودسازی سقف دسترسی (Privilege Boundary)

حوزهٔ دسترسی (Scopes) هر کلید API همواره تابعی از نقش سازندهٔ آن در سازمان است و هیچ کاربری نمی‌تواند کلیدی با اختیارات فراتر از سطح دسترسی مجاز خود تعریف کند.

حفاظت در برابر نفوذ و حملات SSRF

مسدودسازی خودکار درخواست‌های وبهوک به مقاصد حساس نظیر آدرس‌های شبکهٔ محلی (Localhost)، رنج IPهای خصوصی و اینترانت، جهت جلوگیری از هرگونه نفوذ به لایه‌های درونی سرور.

یکپارچگی در پلتفرم

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

با فعال‌سازی هر افزونه، کلیهٔ رخدادهای اختصاصی آن به فهرست ایونت‌های وبهوک اضافه می‌شوند. همچنین می‌توانید در مراحل مختلف اتوماسیون و گردش‌های کاری، اکشن‌های اختصاصی ارسال وبهوک به سرورهای خارجی را فراخوانی کنید.

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

پاسخ به سوالات پرتکرار

سؤال دیگری دارید؟ از صفحه تماس با ما با کارشناسان ما مطرح کنید، یا سایر افزونه‌ها را ببینید.

وب هوک (Webhook) چه کاربردی دارد و چه تفاوتی با API معمولی ایجاد می‌کند؟

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

سرور مقصد چگونه اصالت درخواست‌های ارسالی وب هوک را تأیید می‌کند؟

تمامی ارسال‌ها با استفاده از کلید محرمانهٔ مشترک (Secret Token) به‌صورت هش استاندارد HMAC-SHA256 امضا شده و در هدر درخواست قرار می‌گیرند. سرور مقصد با اعتبارسنجی این امضا، از عدم دست‌کاری داده‌ها و ارسال قطعی آن از سوی پورتال شما اطمینان حاصل می‌کند.

در صورت قطعی یا عدم پاسخ‌گویی سرور مقصد، چه اتفاقی برای رویدادها رخ می‌دهد؟

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

نحوهٔ احراز هویت و ارسال کلید API در درخواست‌ها چگونه است؟

نرم‌افزارها و اسکریپت‌های شما توکن صادرشده را از طریق هدر استاندارد درخواست (HTTP Header Authorization) ارسال می‌کنند. سامانه پس از تطبیق هویت، دسترسی به اندپوینت‌ها را منحصراً در چارچوب محدوده‌های مجاز (Scopes) تعیین‌شده برای آن کلید فراهم می‌سازد.

در صورت افشای ناخواستهٔ یک کلید API، چه اقدامی باید انجام داد؟

شما می‌توانید در هر لحظه توکن افشاشده را تنها با یک کلیک فوراً باطل (Revoke) نمایید. دسترسی کلید باطل‌شده بلافاصله در کل سرور مسدود می‌شود و می‌توانید بی‌درنگ کلید جدیدی با دسترسی‌های موردنظر صادر کنید.

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

۷ روز استفادهٔ رایگان با تمامی افزونه‌ها و امکانات، برای یک شروع بی‌دغدغه؛ هر زمان خواستید، کسب‌وکارتان را به پلن دلخواه ارتقا دهید.

اکسی پورتال با یک هدف روشن متولد شد: پایان‌دادن به سردرگمی خرید و یکپارچه‌سازی نرم‌افزارهای جزیره‌ای. از وب‌سایت و فروشگاه تا ارتباط با مشتری، فاکتور و حسابداری، همه‌چیز بر بستر یک پروندهٔ مشترک و از طریق یک پنل متمرکز مدیریت می‌شود.

© ۱۴۰۵ لوگاتک. تمام حقوق محفوظ است.

اکسی پورتال، محصولی از لوگاتک