inCust Knowledge Base
Архів бази знаньПрограми, інтеграція і API

Налаштування RemoteScanner

🌐 Public

Архівна копія зі старої бази знань inCust (deprecated). Оригінал: https://incust.com/ua/knowledgebase/documentation/settings-for-remotescanner/

Налаштування RemoteScanner

Remote Scanner — мобільний додаток для віддаленого сканування кодів, що використовується разом з чат-ботами та веб-сайтами. Він дозволяє сканувати QR-коди, штрих-коди та інші формати без необхідності реалізовувати сканування безпосередньо у стороннім інтерфейсі — достатньо викликати додаток за посиланням і отримати результат назад.

Режими роботи

Додаток працює у двох режимах:

  1. Самостійний запуск. Користувач відкриває Remote Scanner і сканує будь-який код. Результат відображається у самому додатку.
  2. Виклик із зовнішнього застосунку. Чат-бот або веб-сайт викликає Remote Scanner за спеціальним посиланням. Після сканування результат автоматично надсилається на вказаний endpoint, а керування повертається до зовнішнього додатка.

Можливості

  • Сканування QR-кодів, штрих-кодів усіх поширених форматів.
  • Розпізнавання вмісту: текст, URL, контакти, товари тощо.
  • Запуск з чат-ботів і веб-сайтів за посиланням.
  • Можливість роботи офлайн з подальшою відправкою результату.

Параметри посилання

Виклик RemoteScanner відбувається через посилання з параметрами в query string.

Загальні параметри

  • type — тип операції сканування.
  • url — endpoint, на який буде надіслано результат.
  • user_full_name — ім'я користувача (для контексту відправки).
  • user_chat_id — ідентифікатор користувача у викликаючому чат-боті.
  • lang — мова інтерфейсу сканера.
  • user_lang — мова користувача.

Параметри для фотографій

Якщо тип операції передбачає захоплення фото:

  • countPhotos — кількість кадрів.
  • delayPhotos — затримка між кадрами.
  • externalMask — зовнішня маска для обмеження кадру.

Формат відповіді

Після сканування Remote Scanner формує об'єкт із результатом і надсилає його POST-запитом на endpoint, переданий у параметрі url. Сервер у відповідь має повернути об'єкт із полем success: true у разі успіху або структуру помилки. Сканер обробляє відповідь і повідомляє користувача про результат операції.

On this page