Lyngoh API
This document and the APIs herein are subject to change at any time. Sorry, the API is still under development. We will version the API, but may deprecate early versions aggressively.
URL format
Lyngoh API URLs must be in the following format:
http://api.lyngoh.com/c?<parameter 1>&<parameter 2>&<parameter n>
2D Barcodes Generation
QR codes:
QR codes are a popular type of a matrix code (or two-dimensional bar code) created by Japanese corporation Denso-Wave in 1994. The "QR" is derived from "Quick Response", as the creator intended the code to allow its contents to be decoded at high speed. QR Codes store text which can be a hyperlink, contact information, telephone number, etc.
Specify a QR code with: ct=qr
Data Capacity:
QR code version 1 has 21 rows by 21 columns and is the simplest possible configuration that can encode up to 25 alphanumeric characters.
Configuration grows by 4 modules per side, up to 177 rows by 177 columns at version 40 with capacity for 4296 alphanumeric characters.The Lyngoh API generates the appropriate QR code version depending on the number of characters to encode and the error correction level (EC) choosed to use.
Error Correction
QR codes use the Reed-Solomon error correction and four levels are avaliable.
You can specify EC level with: ec=<EC Level>
Where <EC Level> is one of:
L - 7% of codewords can be restored.
M - 15% of codewords can be restored.
Q - 25% of codewords can be restored.
H - 30% of codewords can be restored.
Datamatrix:
A Data Matrix code is a two-dimensional matrix barcode consisting of black and white square modules arranged in either a square or rectangular pattern. As with QR codes the lengh of the encoded data depends on the symbol dimension used.
Symbol sizes vary from 8x8 to 144x144, encoding up to 2335 alphanumeric characters.
Specify a Datamatrix code with: ct=dm
We will continuously and progressively be adding functionalities to the API. Please send feedback here!