Skip to main content

Getting Started

Main Concept#

  1. The free mobile application scans a bar code or qr code
  2. The value of the scanned code is sent to URL you set.
  3. Based on the response from your endpoint, a green/red screen (with optional custom message) is shown. Sound signal is also played.

Not sure it fits your job? See the use cases: ticket check-in, vouchers, attendance, equipment checkout and more, each with ready-to-edit settings.

Quick start#

  1. Install the app — Android Application (beta)
  2. Configure it — open the settings configurator, enter your API endpoint URL and any other options, and it renders a settings QR code for you.
  3. Scan the settings QR code with the app. It applies and stores the settings immediately.
  4. Test it — scan one of the test codes (no need to hunt for a barcode nearby) and check that your endpoint receives the POST and that the app shows the green/red screen you expect.

No JSON authoring is required. If you would rather write the settings document by hand, the format is documented on the settings JSON document page, and the configurator accepts pasted JSON too.

Ready-made test configurations, each openable in the configurator, start with minimal ok response in the Sample Settings section.

Try scanning QR code in this page and view results realtime in public AIR table:

https://observablehq.com/@matus/scan2check

Distribute to users#

You can distribute the device with pre-configured settings to end users, who will use the mobile app to check & scan codes. Or you can instruct them to scan a QR code you send them by email or text message to initialize the application.

Each device installation has unique deviceId identifier assigned, that is sent with each API request. It is also possible set custom headers of the API request, e.g. a API key or any custom identifier.