Skip to main content
↓ Download as Markdown

Kiosk plugins

On kiosk, a way to serve plugins is from the kiosk shell, where it intercepts plugin requests and responds with a locally served plugin. This makes it possible for the plugin to integrate with hardware available on the kiosk device, such as payment terminals, receipt printers, and barcode scanners.

This is particularly useful when implementing services such as payment, receipt, or scanner services.

Setup​

  1. Notify Future Ordering of the plugin name, version, and port you want to use
  2. Implement in the kiosk shell that it intercepts requests for that plugin
  3. Serve the plugin from a local URL on the kiosk

URL pattern​

The kiosk shell expects the plugin to be served at:

http://localhost:{port}/{pluginName}/{version}/{pluginName}.js

For example, for a plugin named my-plugin at version 1.0.0 served on port 3000:

http://localhost:3000/my-plugin/1.0.0/my-plugin.js