Support Hub/API & Integrations/تست آدرس‌های Callback محصولات Cams به‌صورت محلی با ngrok
Translated from the English article and reviewed by a person. Read the English original
Developer

تست آدرس‌های Callback محصولات Cams به‌صورت محلی با ngrok

تست آدرس‌های Callback محصولات Cams به‌صورت محلی با ngrok

پیش از انتقال یکپارچه‌سازی خود به محیط عملیاتی، می‌توانید درخواست‌های Callback مربوط به Cams API را مستقیماً روی دستگاه توسعه خود با استفاده از یک ابزار تونل‌سازی آزمایش کنید. این راهنما شما را گام‌به‌گام در راه‌اندازی راهنمایی می‌کند.

چرا به تونل نیاز دارید

درخواست‌های Callback و Webhook از طریق اینترنت از پلتفرم Cams ارسال می‌شوند. برنامه محلی که روی دستگاه شما اجرا می‌شود نمی‌تواند این درخواست‌ها را مستقیماً دریافت کند، زیرا پشت یک فایروال یا شبکه NAT قرار دارد.

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

مزایا

  • آزمایش Callbackها پیش از استقرار
  • اشکال‌زدایی payloadهای Webhook به‌صورت بلادرنگ
  • اعتبارسنجی نحوه پردازش درخواست‌ها به‌صورت محلی
  • کاهش زمان توسعه و استقرار

ابزارهای تونل‌سازی توصیه‌شده

راه‌اندازی ngrok (توصیه‌شده)

نصب

  1. به آدرس https://ngrok.com مراجعه کنید
  2. نسخه مناسب سیستم‌عامل خود را دانلود کنید.
  3. فایل اجرایی را استخراج و نصب کنید.
  4. یک حساب کاربری رایگان ایجاد کنید (اختیاری، اما توصیه می‌شود).
  5. AuthToken را تولید کنید.
  6. AuthToken خود را پیکربندی کنید.
    ngrok config add-authtoken YOUR_AUTHTOKEN

شروع یک تونل

اگر ngrok از قبل پیکربندی شده است:
ngrok http 3000
عدد 3000 را با پورت برنامه خود جایگزین کنید.

نمونه خروجی

Forwarding https://abc123.ngrok-free.app -> http://localhost:3000
برنامه شما اکنون از طریق آدرس عمومی HTTPS در دسترس است.

گزینه جایگزین: استفاده از ابزار آزمایش Callback محصولات Cams

همچنین می‌توانید از ابزار آزمایش Callback ارائه‌شده توسط Cams استفاده کنید.

  1. ابزار را با استفاده از لینک زیر نصب کرده و فایل آن را از حالت فشرده خارج کنید.
    https://developer.camsbiometrics.com/setup/ngrok-helper-kit.rar
  2. فایل app.properties را ویرایش کنید.
  3. موارد زیر را پیکربندی کنید:
    ngrok.auth.token=
    ngrok.tunnel.url=
  4. اجرا کنید:
    check_ngrok.bat

این ابزار به‌طور خودکار تونل را برقرار می‌کند و آزمایش محلی Callback را ساده‌تر می‌کند.


راه‌اندازی یکپارچه‌سازی Callback

مرحله ۱: برنامه محلی خود را اجرا کنید
مرحله ۲: تونل را راه‌اندازی کنید
مرحله ۳: Callback را آزمایش کنید
یک رویداد آزمایشی نمونه را ایجاد کنید و موارد زیر را بررسی کنید:

  • برنامه شما درخواست Callback را دریافت می‌کند.
  • payloadهای درخواست با موفقیت پردازش می‌شوند.
  • هیچ خطایی در گزارش‌های برنامه ظاهر نمی‌شود.
  • درخواست‌ها در داشبورد تونل قابل مشاهده هستند.

بهترین روش‌ها

  • در صورت امکان، از آدرس‌های Callback با HTTPS استفاده کنید.
  • در طول آزمایش، تونل را فعال نگه دارید.
  • گزارش‌های برنامه را برای اعتبارسنجی درخواست‌ها بررسی کنید.
  • تأیید کنید که نقطه پایانی شما کدهای پاسخ HTTP مورد انتظار را برمی‌گرداند.
  • پیش از انتقال به محیط عملیاتی، سناریوهای مدیریت خطا را آزمایش کنید.

نکات مهم

  • آدرس‌های ngrok رایگان هر بار که تونل مجدداً راه‌اندازی شود تغییر می‌کنند.
  • طرح‌های پولی ngrok از دامنه‌های رزروشده و زیردامنه‌های سفارشی پشتیبانی می‌کنند.
  • تونل‌های موقت فقط باید برای اهداف توسعه و آزمایش استفاده شوند.

نتیجه‌گیری

در معرض قرار دادن سرور محلی شما از طریق یک سرویس تونل‌سازی، سریع‌ترین راه برای آزمایش آدرس Callback شما پیش از استقرار برنامه است. چه از ngrok، Cloudflare Tunnel یا localhost.run استفاده کنید، این فرایند به شما امکان می‌دهد درخواست‌های Callback بلادرنگ را دریافت کرده و یکپارچه‌سازی خود را در یک محیط توسعه محلی اعتبارسنجی کنید.

پیروی از گام‌های بالا به تضمین انتقالی روان از توسعه به استقرار در محیط عملیاتی کمک می‌کند.

Was this article helpful?