No Description

Matt Clark ac936d92f9 Adding admin.html and updating all Admin API endpoints to return valid JSON responses. Updated cache-dump handler to download cache in JSON format. 11 months ago
config c86bb23830 Validate admin against authlist, adding utility for generating authlist entries, minor refactoring of metrics. 1 year ago
resources ac936d92f9 Adding admin.html and updating all Admin API endpoints to return valid JSON responses. Updated cache-dump handler to download cache in JSON format. 11 months ago
src ac936d92f9 Adding admin.html and updating all Admin API endpoints to return valid JSON responses. Updated cache-dump handler to download cache in JSON format. 11 months ago
.gitignore 2f2b6117e8 Minor refactoring. 1 year ago
LICENSE.md 6a9da4daef Added Readme, URL encoding in requests. 4 years ago
README.md d41377bb6f Minor refactoring of ServerRuntime to include reference to system timer. 11 months ago
pom.xml 2f2b6117e8 Minor refactoring. 1 year ago

README.md

BarcodeAPI.org

The BarcodeAPI.org web server was designed to provide an easy to use barcode generation API via the HTTP protocol for use in external / mobile applications where generation libraries might not exist or resources limited; the WebUI is also designed to be responsive such that users may generate barcodes to be scanned directly from their web browser or download the barcodes after testing them out.

Web Server

The server comes with a minimal set of static HTML and Javascript files that allow users to generate barcodes in their web browser with ease. The UI allows users to quickly download, print, or copy the images for use in other applications.

API Server

The server will generate a barcode for any content passed to the /api endpoint; this can be done using a web browser, fetched through a user script, or even simply with cURL.

curl https://barcodeapi.org/api/A_Barcode > gen.png

Automatic Code Type Detection

When calling the API endpoint without specifying an eplitit code type the server will make its best judgement as to which code type will be best suited for the supplied data.

curl https://barcodeapi.org/api/abc123
curl https://barcodeapi.org/api/auto/abc123

Defined Code Type

A list of all supported barcodes types is available by calling the /types/ endpoint; this will be a JSON Array containing details for each type including a regex format to prevalidate the date before a request.

Specific barcode types may be requested by adding the type string in the request URL:

curl https://barcodeapi.org/api/128/abc123
curl https://barcodeapi.org/api/qr/abc123

Third-Party

BarcodeAPI.org is only made possible with the use of third-party software.

Jetty, Apache 2.0

  • The BarcodeAPI server was built around the Jetty web server framework.

Barcode4J, Apache 2.0

  • Barcode4J is an open source barcode generator; it is used for the generation of the following code types:

ZXing, Apache 2.0

  • ZXing is a barcode processing library that makes QR code generation possible.

License

Copyright 2020 BarcodeAPI.org

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.