Support Hub/API & Integrations/Тестування callback-URL Cams локально за допомогою ngrok
Translated from the English article and reviewed by a person. Read the English original
Developer

Тестування callback-URL Cams локально за допомогою ngrok

Тестування callback-URL 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-URL.

Альтернатива: використання інструмента тестування 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-викликів

Крок 1: Запустіть ваш локальний застосунок
Крок 2: Запустіть тунель
Крок 3: Протестуйте callback-виклик
Ініціюйте тестову подію та перевірте наступне:

  • Ваш застосунок отримує callback-запит.
  • Payload запитів успішно обробляється.
  • У журналах застосунку немає помилок.
  • Запити видно на панелі тунелю.

Рекомендовані методи

  • Використовуйте HTTPS callback-URL, коли це можливо.
  • Підтримуйте тунель активним під час тестування.
  • Перевіряйте журнали застосунку для валідації запитів.
  • Переконайтеся, що ваша кінцева точка повертає очікувані коди відповіді HTTP.
  • Протестуйте сценарії обробки помилок перед переходом у продуктивне середовище.

Важливі примітки

  • URL безкоштовного ngrok змінюються щоразу, коли тунель перезапускається.
  • Платні тарифи ngrok підтримують зарезервовані домени та власні субдомени.
  • Тимчасові тунелі слід використовувати лише для цілей розробки та тестування.

Висновок

Відкриття вашого локального сервера через сервіс тунелювання є найшвидшим способом протестувати ваш callback-URL перед розгортанням застосунку. Незалежно від того, використовуєте ви ngrok, Cloudflare Tunnel чи localhost.run, цей процес дозволяє отримувати callback-запити в реальному часі та перевіряти інтеграцію в локальному середовищі розробки.

Дотримання наведених вище кроків допоможе забезпечити плавний перехід від розробки до розгортання у продуктивному середовищі.

Was this article helpful?