orca-validation-node

How to validate barcode scans using Orca Scan and Node.js

Usage no npm install needed!

<script type="module">
  import orcaValidationNode from 'https://cdn.skypack.dev/orca-validation-node';
</script>

README

orca-validation-node

This is a fully working example of how to validate barcode scans using Orca Scan and Node.js

How it works:

  1. A user scans a barcode using the Orca mobile app
  2. They're presented with a form asking for information
  3. They enter the information and tap save
  4. The information is sent to your Validation URL
  5. Your system validates the information entered

If Valid: You return a HTTP 200 with no body and the app save proceeds.

If Invalid: You return JSON error message, the error is presented to the user and save is rejected.

{
    "title": "Error",
    "description": "Whatever action you need the user to take"
}

Once the user has corrected the error, they tap save and the process returns to point 4.

Install

First ensure you have Node.js installed.

# should return 11 or higher
node -v

Then execute the following:

# download this example code
git clone https://github.com/orca-scan/orca-validation-node.git

# go into the new directory
cd orca-validation-node

# install dependencies
npm install

Run

# start the project
npm start

Troubleshooting

If you run into any issues please open a ticket or chat to us live at orcascan.com

Contributing

To contribute simply:

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

History

For change-log, check releases.

License

Licensed under MIT License © ## History

For change-log, check releases.

License

Licensed under ISC License © Orca Scan, the Barcode Scanner app for iOS and Android.